BaseProvider

Base class for all providers.

class BaseProvider implements OMSSProvider<P>

Constructor

BaseProvider(): BaseProvider<P>

Returns

BaseProvider<P>

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

Resolvers that this provider supports.

supportsId · required

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

Methods

getSources()

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

Fetch sources for a certain media.

Parameters

media · required

Return object of the resolver’s resolve() method.

result · ProviderResultEmitter · required

The result emitter.

Returns

Promise<ProviderResult>