Variable CommentSchemaConst

CommentSchema: ZodObject<{
    author: ZodString;
    comment: ZodOptional<ZodString>;
    date: ZodString;
    modifiedAuthor: ZodOptional<ZodString>;
    modifiedDate: ZodOptional<ZodString>;
    uuid: ZodString;
    viewpoint: ZodOptional<ZodString>;
}, "strip", ZodTypeAny, {
    author: string;
    comment?: string;
    date: string;
    modifiedAuthor?: string;
    modifiedDate?: string;
    uuid: string;
    viewpoint?: string;
}, {
    author: string;
    comment?: string;
    date: string;
    modifiedAuthor?: string;
    modifiedDate?: string;
    uuid: string;
    viewpoint?: string;
}> = ...

The markup file can contain comments related to the topic. Their purpose is to record discussion between different parties related to the topic. Each Comment has a Guid attribute for identifying it uniquely. A comment can reference a viewpoint to support the discussion. At least one of Viewpoint and/or Comment (text) must be provided.

Type declaration

  • author: ZodString

    Comment author.

  • comment: ZodOptional<ZodString>

    The comment text, must not be empty if provided.

  • date: ZodString

    Date of the comment

  • modifiedAuthor: ZodOptional<ZodString>

    The author who modified the comment.

  • modifiedDate: ZodOptional<ZodString>

    The date when comment was modified.

  • uuid: ZodString

    The unique identifier of the entity.

    This is not in the BCF spec, but is used internally. However, when a BCF component requires a GUID, the uuid property is used.

  • viewpoint: ZodOptional<ZodString>

    Back reference to the viewpoint GUID.

Type declaration

  • author: string

    Comment author.

  • Optional comment?: string

    The comment text, must not be empty if provided.

  • date: string

    Date of the comment

  • Optional modifiedAuthor?: string

    The author who modified the comment.

  • Optional modifiedDate?: string

    The date when comment was modified.

  • uuid: string

    The unique identifier of the entity.

    This is not in the BCF spec, but is used internally. However, when a BCF component requires a GUID, the uuid property is used.

  • Optional viewpoint?: string

    Back reference to the viewpoint GUID.

Type declaration

  • author: string

    Comment author.

  • Optional comment?: string

    The comment text, must not be empty if provided.

  • date: string

    Date of the comment

  • Optional modifiedAuthor?: string

    The author who modified the comment.

  • Optional modifiedDate?: string

    The date when comment was modified.

  • uuid: string

    The unique identifier of the entity.

    This is not in the BCF spec, but is used internally. However, when a BCF component requires a GUID, the uuid property is used.

  • Optional viewpoint?: string

    Back reference to the viewpoint GUID.

Settings

Member Visibility

Theme

Generated using TypeDoc