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

    Type Parameters

    • T = unknown

    Hierarchy (View Summary)

    Index

    Constructors

    • Type Parameters

      • T = unknown

      Parameters

      • __namedParameters: { source: Source }

      Returns Shape<T>

    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

    • Type Parameters

      • E = unknown

      Parameters

      • value: E

      Returns boolean

    • Returns string

    • Returns Plugin | undefined

    • Finds every shape nested within this one, including this shape itself, that matches shapeClass. Nested shapes are collected unresolved, mirroring what getCode() serializes.

      Useful for reaching shapes that still need handling of their own after their subtree was serialized in one shot via getCode(), a path where no per-shape commit runs — see NowIncludeShape, whose backing script file has to be written separately.

      Container shapes override this to walk what they nest.

      Type Parameters

      • const S extends Shape<unknown>

      Parameters

      Returns S[]

    • Returns string

    • Returns string

    • Returns { recordId: string; table: string } | undefined

    • Returns string

    • Returns Node

    • Returns Source

    • Gets the value of the shape.

      Returns T

    • Returns Record<string, string>

    • 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 Shape<T> | undefined

    • Returns IdentifierShape | undefined

    • Returns NumberShape | undefined

    • Returns ObjectShape | undefined

    • Returns Record | undefined

    • Returns RecordId | undefined

    • Returns ResolvableShape | undefined

    • Returns StringShape | undefined

    • Returns StringLiteralShape | 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 Shape<T>

    • Returns this is IdentifierShape

    • Returns this is NoOpShape

    • Returns this is NumberShape

    • Returns this is ObjectShape

    • Returns this is Record

    • Returns this is RecordId

    • Returns this is ResolvableShape

    • Returns this is StringShape

    • Returns this is StringLiteralShape

    • Returns this is UndefinedShape

    • Returns this is UnresolvedShape

    • Marks this shape as generated (via now-sdk transform) for a record with no prior Fluent representation.

      Parameters

      Returns this

    • Returns this

    • Parameters

      • predicate: (shape: Shape) => boolean

      Returns this

    • Type Parameters

      • T

      Parameters

      • pipeFn: (shape: this) => T

      Returns T

    • Parameters

      • creator: Plugin | undefined
      • Optionaloverwrite: boolean

      Returns this

    • Returns boolean

    • Returns BooleanShape

    • Returns NumberShape

    • Returns RecordId

    • Returns a string representation of an object.

      Returns StringShape

    • 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 | undefined

      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

    • Parameters

      Returns string

    • 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