Nutrient Web SDK
    Preparing search index...

    Type Alias TemplateDataToPopulateDocument

    Describes the data format used to populate a document template.

    type TemplateDataToPopulateDocument = {
        config?: {
            delimiter?: {
                end?: string;
                objectDelimiter?: string;
                start?: string;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
        model: TemplateModel;
    }
    Index

    Properties

    config? model

    Properties

    config?: {
        delimiter?: {
            end?: string;
            objectDelimiter?: string;
            start?: string;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    }

    Optional configuration used to populate the document template. When omitted, default delimiters { and } are used.

    Type Declaration

    • [key: string]: unknown

      Additional vendor-specific config keys are forwarded as-is.

    • Optionaldelimiter?: {
          end?: string;
          objectDelimiter?: string;
          start?: string;
          [key: string]: unknown;
      }

      The delimiter settings used in data parsing.

      • Optionalend?: string

        The end delimiter for data parsing. Defaults to } when omitted.

      • OptionalobjectDelimiter?: string

        Optional separator used to treat dotted markers as literal keys instead of object navigation. Example: with objectDelimiter: "|", {{opps.length()}} resolves the literal "opps.length()" key.

      • Optionalstart?: string

        The start delimiter for data parsing. Defaults to { when omitted.

    model: TemplateModel

    The data used to populate the document template, including text/loop/image markers.

    Settings

    Member Visibility

    On This Page

    Properties