newPublisherDocumentDefinitionFromTemplateV1()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Creates a document definition from a template.
export declare function newPublisherDocumentDefinitionFromTemplateV1(template: IPublisherDocumentTemplateV1 | IPublisherDocumentTemplateDefinitionV1, options: {
title: string;
periodStart: PublisherDateStringV1;
periodEnd: PublisherDateStringV1;
}, modifications?: Partial<Omit<IPublisherDocumentDefinitionV1, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IPublisherDocumentDefinitionV1;
Parameters
Parameter | Type | Description |
|---|---|---|
template | IPublisherDocumentTemplateV1 | IPublisherDocumentTemplateDefinitionV1 | |
options | { title: string; periodStart: PublisherDateStringV1; periodEnd: PublisherDateStringV1; } | |
modifications | Partial<Omit<IPublisherDocumentDefinitionV1, “type” | “title” | “periodStart” | “periodEnd” | “content”>> | (Optional) |
Returns
IPublisherDocumentDefinitionV1
Remarks
The template content is deep-copied; no reference to the template is kept, so the document stays frozen while the template evolves.