Skip to main content

MockFetchApiOptions

Home > @backstage/test-utils > MockFetchApiOptions

The options given when constructing a MockFetchApi.

Signature:

export interface MockFetchApiOptions 

Properties

PropertyModifiersTypeDescription
baseImplementation?undefined | 'none' | typeof crossFetch(Optional) Define the underlying base fetch implementation.
injectIdentityAuth?undefined | { token: string; } | { identityApi: Pick<IdentityApi, 'getCredentials'>; }(Optional) Add token based Authorization headers to requests, basically simulating what FetchMiddlewares.injectIdentityAuth() does.
resolvePluginProtocol?undefined | { discoveryApi: Pick<DiscoveryApi, 'getBaseUrl'>; }(Optional) Add translation from plugin:// URLs to concrete http(s) URLs, basically simulating what FetchMiddlewares.resolvePluginProtocol() does.