OMSSProvider

Core provider interface.

Properties

catalog

Catalog of media this provider supports. It does not have to exist. If it does, it should be a list of media IDs. This does not get queried for source resolving, but more metadata about the provider.

enabled · boolean · required

Whether the provider will be used.

id · string · required

Provider ID. Must be unique.

name · string · required

Friendly name of the provider.

resolver · P · required

Resolver that this provider is bound to.

supportsId · required

Provide a method that checks whether this provider supports a certain ID.

Methods

getSources()

getSources(request: ProviderSourcesMeta<ResolverMetadata<P>>, result: ProviderResultEmitter): Promise<ProviderResult>

Fetch sources for a certain request. The shape of request.meta is derived from the resolver’s resolve() return type.

Parameters

request · required

result · ProviderResultEmitter · required

Returns

Promise<ProviderResult>