noggin

Provider registry

The process-wide catalog of provider modules. Importing a provider (e.g. import '@noggin/engine/providers/file') side-effect-registers it here. Hosts can also register custom providers programmatically.

providers

const providers: NogginProviderRegistry;

The process-wide noggin provider registry.

NogginProvider

A noggin provider: claims a scheme prefix, opens a NogginStore.

Properties

PropertyModifierType
schemereadonlystring

Methods

open()
open(location: string, opts?: object): Promise<NogginStore>;
Parameters
ParameterType
locationstring
opts?object
Returns

Promise<NogginStore>

NogginProviderRegistry

Registry interface. The exported providers is the singleton.

Methods

get()
get(scheme: string): NogginProvider;
Parameters
ParameterType
schemestring
Returns

NogginProvider

list()
list(): readonly {
  scheme: string;
}[];
Returns

readonly { scheme: string; }[]

register()
register(provider: NogginProvider): void;
Parameters
ParameterType
providerNogginProvider
Returns

void

unregister()
unregister(scheme: string): boolean;
Parameters
ParameterType
schemestring
Returns

boolean