StaticStoryCatalog
class exported by @mwillbanks/tuil-story.
class
Public class exported by @mwillbanks/tuil-story.
export class StaticStoryCatalog {
readonly #catalog: TuilStoryCatalog;
constructor() {
this.#catalog = new TuilStoryCatalog();
}
register<TProps>(
id: string,
definition: TuilStoryDefinition<
TProps,
Readonly<Record<string, TuilStory<TProps>>>
>,
): Disposer {
const registration = this.#catalog.register(id, id, definition);
return () => registration.dispose();
}
get runtimeCatalog(): TuilStoryCatalog {
return this.#catalog;
}
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
#catalog | TuilStoryCatalog | Yes | The #catalog member uses the TuilStoryCatalog contract. | TuilStoryCatalog |
__constructor | any | Yes | The __constructor member uses the any contract. | — |
register | <TProps>(id: string, definition: TuilStoryDefinition<TProps, Readonly<Record<string, TuilStory<TProps>>>>) => Disposer | Yes | The register member uses the <TProps>(id: string, definition: TuilStoryDefinition<TProps, Readonly<Record<string, TuilStory<TProps>>>>) => Disposer contract. | Disposer, TuilStory, TuilStoryDefinition |
runtimeCatalog | TuilStoryCatalog | Yes | The runtimeCatalog member uses the TuilStoryCatalog contract. | TuilStoryCatalog |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference