@servicenow/sdk - v4.13.3
    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 getDescendants getDescription getId getInstallCategory getKind getNewlyCreatedRecord getOriginalFilePath getOriginalNode getOriginalSource getOverrideKeys getRelated getSource getTable getTelemetryMeta 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 markAsNewlyCreatedRecord merge omit omitFromXmlIfUndefined omitFromXmlWhen pick pipe properties setCreator setTelemetryMeta shouldOmitFromXml startTracking strictEquals toBoolean toNumber toRecordId toString transform values with withAliasedKeys withOverrideKeys withXmlAttribute from getOriginalFilePath getOriginalSource 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

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

    • Returns InstallCategory

    • Returns string

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

    • 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 the telemetry metadata attached via setTelemetryMeta, or undefined if none.

      Returns Record<string, unknown> | undefined

    • 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[]

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

      Parameters

      Returns this

    • Parameters

      • other: object

      Returns Record

    • Parameters

      Returns Record<string, Shape>

    • Returns this

    • Parameters

      • predicate: (shape: Shape) => boolean

      Returns this

    • Parameters

      Returns Record<string, Shape>

    • Type Parameters

      • T

      Parameters

      • pipeFn: (shape: this) => T

      Returns T

    • Parameters

      • creator: Plugin | undefined
      • Optionaloverwrite: boolean

      Returns this

    • Attaches extra properties to this record's fluent.authored telemetry event (merged into the event alongside api_name, entity_id, etc). Plugins use this to report a small amount of structured, non-sensitive metadata about the record — e.g. the Table plugin reports column_count/column_types. Calls merge, so it can be invoked more than once.

      Keep the payload small and low-cardinality: values become PostHog event properties, which are subject to PostHog's per-event size/property limits and inflate storage/query cost. Never put PII, raw sys_ids, or free-form user content here.

      Parameters

      Returns this

    • Returns boolean

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

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