tuil
ReferencePackages@mwillbanks/tuil-storyAPI

createFumadocsStoryAdapter

function exported by @mwillbanks/tuil-story.

View rawEdit

function

Public function exported by @mwillbanks/tuil-story.

export function createFumadocsStoryAdapter(
  set: TuilStorySet | BrowserStorySet,
  options: { readonly endpoint?: string } = {},
): Readonly<Record<string, FumadocsStoryConfig>>;

Members

This declaration has no public members.

Parameters

MemberTypeRequiredDescriptionRelated types
setTuilStorySet | BrowserStorySetYesSupplies the set value as TuilStorySet | BrowserStorySet.BrowserStorySet, TuilStorySet
options&#123; readonly endpoint?: string &#125;NoSupplies the options value as &#123; readonly endpoint?: string &#125;.

Returns

Readonly<Record<string, FumadocsStoryConfig>> — Returns a value that satisfies Readonly<Record<string, FumadocsStoryConfig>>.

Related types: FumadocsStoryConfig

Throws

No thrown errors are documented for this declaration.

Source

View the secondary source reference

Package

@mwillbanks/tuil-story

On this page