Function createApiRef

createApiRef<T>(
config: ApiRefConfig,
): ApiRef<T> & { $$type: "@backstage/ApiRef" }
Creates a reference to an API.
Type Parameters
- T
Parameters
- config: ApiRefConfig
Returns ApiRef<T> & { $$type: "@backstage/ApiRef" }
Deprecated
Use createApiRef<T>().with(...) instead.
- Defined in packages/frontend-plugin-api/src/apis/system/ApiRef.ts:94
createApiRef<T>(): {
    with<const TId extends string>(
        config: ApiRefConfig & { id: TId; pluginId?: string },
    ): ApiRef<T, TId> & { $$type: "@backstage/ApiRef" };
}
Creates a reference to an API.
Type Parameters
- T
Returns {
    with<const TId extends string>(
        config: ApiRefConfig & { id: TId; pluginId?: string },
    ): ApiRef<T, TId> & { $$type: "@backstage/ApiRef" };
}
Remarks
Returns a builder with a .with() method for providing the API reference configuration.
- Defined in packages/frontend-plugin-api/src/apis/system/ApiRef.ts:107