tuil
ReferencePackages@mwillbanks/tuil-storyAPI

StaticStoryCatalog

class exported by @mwillbanks/tuil-story.

View rawEdit

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

MemberTypeRequiredDescriptionRelated types
#catalogTuilStoryCatalogYesThe #catalog member uses the TuilStoryCatalog contract.TuilStoryCatalog
__constructoranyYesThe __constructor member uses the any contract.
register<TProps>(id: string, definition: TuilStoryDefinition<TProps, Readonly<Record<string, TuilStory<TProps>>>>) => DisposerYesThe register member uses the <TProps>(id: string, definition: TuilStoryDefinition<TProps, Readonly<Record<string, TuilStory<TProps>>>>) => Disposer contract.Disposer, TuilStory, TuilStoryDefinition
runtimeCatalogTuilStoryCatalogYesThe 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.

Source

View the secondary source reference

Package

@mwillbanks/tuil-story

On this page