Type alias EditionMetadata

EditionMetadata: {
    title: string;
    description: string;
    language: Language;
    embed?: {
        declaration: EmbedDeclaration;
        dependencies?: EmbedDependencies;
    };
}

Edition metadata passed to ServerClient.createEditions and ServerClient.updateEditions.

Type declaration

  • title: string

    Title in the matching language to overwrite the pack title. Generally, written for SEO. Will automatically be set to null if same as pack title.

  • description: string

    A longer description in the matching language to override the pack description. Generally, written for SEO. Will be automatically set to null if same as pack description.

  • language: Language
  • Optional embed?: {
        declaration: EmbedDeclaration;
        dependencies?: EmbedDependencies;
    }

Settings

Member Visibility

Theme

Generated using TypeDoc