• Preparing search index...
  • The search index is not available
@shopify/cli-kit
  • @shopify/cli-kit
  • node/metadata
  • createRuntimeMetadataContainer

Function createRuntimeMetadataContainer

  • createRuntimeMetadataContainer<
        TPublic extends AnyJson,
        TSensitive extends AnyJson = { [key: string]: never },
    >(
        defaultPublicMetadata?: Partial<TPublic>,
    ): RuntimeMetadataManager<TPublic, TSensitive>
  • Creates a container for metadata collected at runtime. The container provides async-safe functions for extracting the gathered metadata, and for setting it.

    Type Parameters

    • TPublic extends AnyJson
    • TSensitive extends AnyJson = { [key: string]: never }

    Parameters

    • defaultPublicMetadata: Partial<TPublic> = {}

      Optional, default data for the container.

    Returns RuntimeMetadataManager<TPublic, TSensitive>

    A container for the metadata.

    • Defined in packages/cli-kit/src/public/node/metadata.ts:62

Settings

Member Visibility
@shopify/cli-kit
  • Loading...

Generated using TypeDoc