Type alias PublishObjectData

PublishObjectData: {
    boolean?: never;
    bytes?: never;
    json?: never;
    number?: never;
    objectId?: never;
    string: string;
} | {
    boolean?: never;
    bytes?: never;
    json?: never;
    number: number;
    objectId?: never;
    string?: never;
} | {
    boolean: boolean;
    bytes?: never;
    json?: never;
    number?: never;
    objectId?: never;
    string?: never;
} | {
    boolean?: never;
    bytes: Buffer | ArrayBuffer;
    json?: never;
    number?: never;
    objectId?: never;
    string?: never;
} | {
    boolean?: never;
    bytes?: never;
    json: JsonArray | JsonObject;
    number?: never;
    objectId?: never;
    string?: never;
} | {
    boolean?: never;
    bytes?: never;
    json?: never;
    number?: never;
    objectId: string;
    string?: never;
}

Represents a leaf data value used when publishing operations via publish. Either a primitive value or a reference to another object. Exactly one property must be set, indicating the type.

Type declaration

  • Optional boolean?: never

    Not applicable.

  • Optional bytes?: never

    Not applicable.

  • Optional json?: never

    Not applicable.

  • Optional number?: never

    Not applicable.

  • Optional objectId?: never

    Not applicable.

  • string: string

    A string value.

Type declaration

  • Optional boolean?: never

    Not applicable.

  • Optional bytes?: never

    Not applicable.

  • Optional json?: never

    Not applicable.

  • number: number

    A numeric value.

  • Optional objectId?: never

    Not applicable.

  • Optional string?: never

    Not applicable.

Type declaration

  • boolean: boolean

    A boolean value.

  • Optional bytes?: never

    Not applicable.

  • Optional json?: never

    Not applicable.

  • Optional number?: never

    Not applicable.

  • Optional objectId?: never

    Not applicable.

  • Optional string?: never

    Not applicable.

Type declaration

  • Optional boolean?: never

    Not applicable.

  • bytes: Buffer | ArrayBuffer

    A binary value.

  • Optional json?: never

    Not applicable.

  • Optional number?: never

    Not applicable.

  • Optional objectId?: never

    Not applicable.

  • Optional string?: never

    Not applicable.

Type declaration

  • Optional boolean?: never

    Not applicable.

  • Optional bytes?: never

    Not applicable.

  • json: JsonArray | JsonObject

    A JSON value (array or object).

  • Optional number?: never

    Not applicable.

  • Optional objectId?: never

    Not applicable.

  • Optional string?: never

    Not applicable.

Type declaration

  • Optional boolean?: never

    Not applicable.

  • Optional bytes?: never

    Not applicable.

  • Optional json?: never

    Not applicable.

  • Optional number?: never

    Not applicable.

  • objectId: string

    A reference to another object by its ID.

  • Optional string?: never

    Not applicable.

Settings

Member Visibility

Theme

Generated using TypeDoc