Skip to content

Commit

Permalink
Auto generated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed May 15, 2024
1 parent d6b1dca commit dbf242c
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/pages](./pages.md) &gt; [TemplateConfig](./pages.templateconfig.md) &gt; [additionalProperties](./pages.templateconfig.additionalproperties.md)

## TemplateConfig.additionalProperties property

The field to pass additional metadata

**Signature:**

```typescript
additionalProperties?: string;
```
1 change: 1 addition & 0 deletions packages/pages/docs/api/pages.templateconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export interface TemplateConfig

| Property | Modifiers | Type | Description |
| ----------------------------------------------------------------------------- | --------- | --------------------------- | ------------------------------------------------------------------------------------------------------------ |
| [additionalProperties?](./pages.templateconfig.additionalproperties.md) | | string | _(Optional)_ The field to pass additional metadata |
| [alternateLanguageFields?](./pages.templateconfig.alternatelanguagefields.md) | | string\[\] | _(Optional)_ The specific fields to add additional language options to based on the stream's localization |
| [hydrate?](./pages.templateconfig.hydrate.md) | | boolean | _(Optional)_ Determines if hydration is allowed or not for webpages |
| [name?](./pages.templateconfig.name.md) | | string | _(Optional)_ The name of the template feature. If not defined uses the template filename (without extension) |
Expand Down
3 changes: 2 additions & 1 deletion packages/pages/etc/pages.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,7 @@ export type Template<T extends TemplateRenderProps> = (

// @public
export interface TemplateConfig {
additionalProperties?: string;
alternateLanguageFields?: string[];
hydrate?: boolean;
name?: string;
Expand Down Expand Up @@ -375,7 +376,7 @@ export type TransformProps<T extends TemplateProps> = (props: T) => Promise<T>;

// Warnings were encountered during analysis:
//
// dist/types/src/common/src/template/types.d.ts:178:5 - (ae-forgotten-export) The symbol "ProjectStructureConfig" needs to be exported by the entry point index.d.ts
// dist/types/src/common/src/template/types.d.ts:180:5 - (ae-forgotten-export) The symbol "ProjectStructureConfig" needs to be exported by the entry point index.d.ts

// (No @packageDocumentation comment for this package)
```

0 comments on commit dbf242c

Please sign in to comment.