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

    Class Record

    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 flat get getAction getAliasedKeys getAliases getCode getCount getCreator getDefault getDescription getId getInstallCategory getKind getOriginalFilePath getOriginalNode getOriginalSource getOverrideKeys getRelated getSource getTable getTrackedFields getValue getXmlAttributes has if ifArray ifBoolean ifDefined ifIdentifier ifNumber ifObject ifRecord ifRecordId ifResolvable ifString ifStringLiteral ifUndefined ifUnresolved is isArray isBoolean isDefined isDeleted isIdentifier isNoOp isNumber isObject isRecord isRecordId isResolvable isString isStringLiteral isUndefined isUnresolved keys merge omit pick pipe properties setCreator startTracking strictEquals toBoolean toNumber toRecordId toString transform values with withAliasedKeys withOverrideKeys withXmlAttribute from isDeleteAction noOp quotePropertyNameIfNeeded

    Constructors

    • Parameters

      Returns Record

    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 UndefinedShape

    • Parameters

      • OptionalfailureMessage: string

      Returns UnresolvedShape

    • Parameters

      • other: unknown

      Returns boolean

    • Parameters

      • key: string

      Returns string | undefined

    • Returns a flattened array containing this record and all related records recursively. Includes this record, its direct children, and all descendants.

      Returns Record[]

    • Parameters

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

      Returns Shape

    • Returns Action

    • Returns Record<string, string[]>

    • Parameters

      • key: string

      Returns string[]

    • Returns string

    • Returns number

    • Returns Plugin | undefined

    • Parameters

      • property: string

      Returns Shape

    • Returns string

    • Returns RecordId

    • Returns InstallCategory

    • Returns string

    • Returns string

    • Returns Node

    • Returns Set<string> | undefined

    • Returns the direct related records (one level deep only). Does not include nested descendants.

      Returns Record[]

      Prefer flat() for read-only traversal of all descendants. Avoid getRelated() unless you need the immediate-children relationship to reconstruct nested .with() chains.

    • Returns Source

    • Returns string

    • Returns Set<string>

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

    • Returns NumberShape | undefined

    • Returns ObjectShape | undefined

    • Returns Record | undefined

    • Returns RecordId | undefined

    • Returns StringShape | 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 Record

    • Returns boolean

    • Returns this is NoOpShape

    • Returns this is NumberShape

    • Returns this is ObjectShape

    • Returns this is Record

    • Returns this is RecordId

    • Returns this is StringShape

    • Parameters

      • OptionalnonDefaultsOnly: boolean

      Returns string[]

    • Parameters

      • other: object

      Returns Record

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

    • Useful when you need to know if this record is equal to another not just in terms of its identity but also its data.

      Parameters

      • other: unknown

      Returns boolean

    • Returns NumberShape

    • Returns RecordId

    • Returns a string representation of an object.

      Returns StringShape

    • Parameters

      Returns this

    • Parameters

      • aliasedKeys: Record<string, string[]>

      Returns this

    • Parameters

      • keys: Set<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

    • Parameters

      Returns boolean

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