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

    Class Shape<T>Abstract

    Type Parameters

    • T = unknown

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    as asArray asBoolean asIdentifier asNumber asObject asRecord asRecordId asResolvable asString asStringLiteral asUndefined asUnresolved equals getCode getCreator getDescription getKind getOriginalFilePath getOriginalNode getOriginalSource getSource getValue 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 pipe setCreator toBoolean toNumber toRecordId toString from noOp

    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

    • Returns string

    • Returns string

    • Returns string

    • Returns Node

    • Returns Source

    • Gets the value of the shape.

      Returns T

    • 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

    • 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

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods