@servicenow/sdk - v4.9.0
    Preparing search index...

    Class ObjectShape

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    setProperties

    Methods

    as asArray asBoolean asIdentifier asNumber asObject asRecord asRecordId asResolvable asString asStringLiteral asUndefined asUnresolved entries equals findAliasUsed get getAliasedKeys getAliases getCode getCreator getDefault getDescription getKind getOriginalFilePath getOriginalNode getOriginalSource getSource getValue getXmlAttributes has if ifArray ifBoolean ifDefined ifIdentifier ifNumber ifObject ifRecord ifRecordId ifResolvable ifString ifStringLiteral ifUndefined ifUnresolved is isArray isBoolean isDefined isIdentifier isNoOp isNumber isObject isRecord isRecordId isResolvable isString isStringLiteral isUndefined isUnresolved keys merge omit pick pipe properties setCreator toBoolean toNumber toRecordId toString transform values withAliasedKeys withXmlAttribute from noOp quotePropertyNameIfNeeded

    Constructors

    • Parameters

      • __namedParameters: { properties: object; source: Source }

      Returns ObjectShape

    Properties

    setProperties: Record<string, Shape>

    Methods

    • Type Parameters

      Parameters

      • shapeClasses: { [I in string | number | symbol]: ShapeClass<T[I]> }
      • OptionalfailureMessage: string

      Returns T[number]

    • Type Parameters

      • const S extends Shape<unknown>

      Parameters

      • shapeClass: ShapeClass<S>
      • OptionalfailureMessage: string

      Returns S

    • Parameters

      • OptionalfailureMessage: string

      Returns ArrayShape

    • Parameters

      • OptionalfailureMessage: string

      Returns BooleanShape

    • Parameters

      • OptionalfailureMessage: string

      Returns IdentifierShape

    • Parameters

      • OptionalfailureMessage: string

      Returns NumberShape

    • Parameters

      • OptionalfailureMessage: string

      Returns ObjectShape

    • Parameters

      • OptionalfailureMessage: string

      Returns Record

    • Parameters

      • OptionalfailureMessage: string

      Returns RecordId

    • Parameters

      • OptionalfailureMessage: string

      Returns ResolvableShape

    • Parameters

      • OptionalfailureMessage: string

      Returns StringShape

    • Parameters

      • OptionalfailureMessage: string

      Returns StringLiteralShape

    • Parameters

      • OptionalfailureMessage: string

      Returns UndefinedShape

    • Parameters

      • OptionalfailureMessage: string

      Returns UnresolvedShape

    • Parameters

      Returns [string, Shape<unknown>][]

    • Parameters

      • other: unknown

      Returns boolean

    • Parameters

      • key: string

      Returns string | undefined

    • Parameters

      • propertyOrPath: string | [string, ...string[]]
      • Optionalresolve: boolean

      Returns Shape

    • Returns Record<string, string[]>

    • Parameters

      • key: string

      Returns string[]

    • Returns string

    • Returns Plugin | undefined

    • Parameters

      • property: string

      Returns Shape

    • Returns string

    • Returns string

    • Returns string

    • Returns Node

    • Returns Source

    • Gets the value of the shape.

      Parameters

      • OptionalnonDefaultsOnly: boolean

      Returns Record<string, unknown>

    • Returns Record<string, string>

    • Parameters

      • property: string

      Returns boolean

    • Type Parameters

      Parameters

      • shapeClasses: { [I in string | number | symbol]: ShapeClass<T[I]> }
      • OptionalfailureMessage: string

      Returns T[number] | undefined

    • Type Parameters

      • const S extends Shape<unknown>

      Parameters

      • shapeClass: ShapeClass<S>
      • OptionalfailureMessage: string

      Returns S | undefined

    • Returns ArrayShape | undefined

    • Returns BooleanShape | undefined

    • Returns ObjectShape | undefined

    • Returns IdentifierShape | undefined

    • Returns NumberShape | undefined

    • Returns ObjectShape | undefined

    • Returns Record | undefined

    • Returns RecordId | undefined

    • Returns ResolvableShape | undefined

    • Returns StringShape | undefined

    • Returns UndefinedShape | undefined

    • Returns UnresolvedShape | undefined

    • Type Parameters

      Parameters

      • shapeClasses: { [I in string | number | symbol]: ShapeClass<T[I]> }
      • OptionalfailureMessage: string

      Returns this is T[number]

    • Type Parameters

      • const S extends Shape<unknown>

      Parameters

      • shapeClass: ShapeClass<S>
      • OptionalfailureMessage: string

      Returns this is S

    • Returns this is ArrayShape

    • Returns this is BooleanShape

    • Returns this is ObjectShape

    • Returns this is NoOpShape

    • Returns this is NumberShape

    • Returns this is ObjectShape

    • Returns this is Record

    • Returns this is RecordId

    • Returns this is StringShape

    • Returns this is UndefinedShape

    • Parameters

      • OptionalnonDefaultsOnly: boolean

      Returns string[]

    • Parameters

      • other: object

      Returns ObjectShape

    • Parameters

      Returns Record<string, Shape>

    • Parameters

      Returns Record<string, Shape>

    • Type Parameters

      • T

      Parameters

      • pipeFn: (shape: this) => T

      Returns T

    • Parameters

      • creator: Plugin | undefined
      • Optionaloverwrite: boolean

      Returns this

    • Returns BooleanShape

    • Returns NumberShape

    • Returns RecordId

    • Returns a string representation of an object.

      Returns StringShape

    • Parameters

      Returns ObjectShape

    • Parameters

      • aliasedKeys: Record<string, string[]>

      Returns this

    • Attaches an XML attribute to be emitted on this field's element when the record is written to file, e.g. <field display_value="...">value</field>. Lets a plugin customize a single field's XML attributes without overriding the entire toFile serialization loop.

      Parameters

      • name: string
      • value: string

      Returns this

    • Instantiate an appropriate shape from the given value. If the value is already a shape, it will be returned as-is.

      Parameters

      Returns Shape

    • Instantiate a NoOpShape which has no value and will not generate or update any code. Useful for shapes that are not supported for bidirectional sync.

      Parameters

      Returns NoOpShape

    • Parameters

      • name: string

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods