Class RecordAbstract

Readonly fieldCount

Abstract length

• get length(): number

• Returns the number of members contained in this Record.

  Returns number

tag

• get tag(): string

• Returns the key string of the first member of this Record, if the first member is an [[Attr]]; otherwise returns undefined if the first member is not an Attr.

  Used to concisely get the name of the discriminating attribute of a structure. The tag can be used to discern the nominal type of a polymorphic structure, similar to an XML element tag.

  Returns string

target

• get target(): Value

• Returns the [[Record.flattened flattened]] members of this Record after all attributes have been removed.

  Used to concisely get the scalar value of an attributed structure. An attributed structure is a Record with one or more attributes that modify one or more other members.

  Returns Value

typeOrder

• get typeOrder(): number

• Returns the heterogeneous sort order of this Item. Used to impose a total order on the set of all items. When comparing two items of different types, the items order according to their typeOrder.

  Returns number

valueCount

• get valueCount(): number

• Returns the number of [[Value]] members contained in this Record.

  Returns number

alias

• alias(): void

• Returns void

appended

• appended(...items): Record

• Parameters

  • Rest ...items: ItemLike[]

  Returns Record

attr

• attr(key, value?): Record

• Parameters

  • key: TextLike

  • Optional value: ValueLike

  Returns Record

body

• body(): Value

• Returns the [[Record.flattened flattened]] [[Record.tail tail]] of this Record. Used to recursively deconstruct a structure, terminating with its last Value, rather than a unary Record containing its last value, if the structure ends with a Value member.

  Returns Value

branch

• branch(): Record

• Returns Record

build

• build(): Record

• Returns Record

Abstract clear

• clear(): void

• Returns void

clone

• clone(): Record

• Returns Record

commit

• commit(): Record

• Returns Record

compareTo

• compareTo(that): number

• Parameters

  • that: unknown

  Returns number

concat

• concat(...items): Record

• Parameters

  • Rest ...items: ItemLike[]

  Returns Record

debug

• debug<T>(output): Output<T>

• Type Parameters

  • T

  Parameters

  • output: Output<T>

  Returns Output<T>

Abstract delete

• delete(key): Item

• Parameters

  • key: ValueLike

  Returns Item

deleted

• deleted(key): Record

• Parameters

  • key: ValueLike

  Returns Record

equals

• equals(that): boolean

• Parameters

  • that: unknown

  Returns boolean

equivalentTo

• equivalentTo(that, epsilon?): boolean

• Parameters

  • that: unknown

  • Optional epsilon: number

  Returns boolean

evaluate

• evaluate(interpreter): Record

• Parameters

  • interpreter: InterpreterLike

  Returns Record

flattened

• flattened(): Value

• Returns the sole member of this Record, if this Record has exactly one member, and its member is a Value; returns [[Extant]] if this Record is empty; otherwise returns this if this Record has more than one member.

  Used to convert a unary Record into its member Value. Facilitates writing code that treats a unary Record equivalently to a bare Value.

  Returns Value

Abstract forEach

• forEach<T>(callback): T

• Type Parameters

  • T

  Parameters

  • callback: ((item, index) => void | T)

    • • (item, index): void | T

      • Parameters

        • item: Item

        • index: number

        Returns void | T

  Returns T

• forEach<T, S>(callback, thisArg): T

• Type Parameters

  • T

  • S

  Parameters

  • callback: ((this, item, index) => void | T)

    • • (this, item, index): void | T

      • Parameters

        • this: S

        • item: Item

        • index: number

        Returns void | T

  • thisArg: S

  Returns T

get

• get(key): Value

• Returns the value of the last [[Field]] member of this Record whose key is equal to the given key; returns [[Absent]] if this Record has no Field member with a key equal to the given key.

  Parameters

  • key: ValueLike

  Returns Value

getAttr

• getAttr(key): Value

• Returns the value of the last [[Attr]] member of this Record whose key is equal to the given key; returns [[Absent]] if this Record has no Attr member with a key equal to the given key.

  Parameters

  • key: TextLike

  Returns Value

getField

• getField(key): Field

• Returns the last [[Field]] member of this Record whose key is equal to the given key; returns undefined if this Record has no Field member with a key equal to the given key.

  Parameters

  • key: ValueLike

  Returns Field

Abstract getItem

• getItem(index): Item

• Returns the member of this Record at the given index, if the index is greater than or equal to zero, and less than the [[Record.length length]] of this Record; otherwise returns [[Absent]] if the index is out of bounds.

  Parameters

  • index: NumLike

  Returns Item

getSlot

• getSlot(key): Value

• Returns the value of the last [[Slot]] member of this Record whose key is equal to the given key; returns [[Absent]] if this Record has no Slot member with a key equal to the given key.

  Parameters

  • key: ValueLike

  Returns Value

has

• has(key): boolean

• Returns true if this Record has a [[Field]] member with a key that is equal to the given key; otherwise returns false if this Record has no Field member with a key equal to the given key.

  Parameters

  • key: ValueLike

  Returns boolean

hashCode

• hashCode(): number

• Returns number

head

• head(): Item

• Returns the first member of this Record, if this Record is non-empty; otherwise returns [[Absent]].

  Returns Item

header

• header(tag): Value

• Returns the value of the first member of this Record, if the first member is an [[Attr]] whose key string is equal to tag; otherwise returns [[Absent]] if the first member of this Record is not an Attr, or if the first member of this Record is an Attr whose key does not equal the tag.

  Used to conditionally get the value of the head Attr of a structure, if and only if the key string of the head Attr is equal to the tag. Can be used to check if a structure might conform to a nominal type named tag, while simultaneously getting the value of the tag attribute.

  Parameters

  • tag: string

  Returns Value

headers

• headers(tag): Record

• Returns the [[Record.unflattened unflattened]] [[Record.header header]] of this Record. The headers of the tag attribute of a structure are like the attributes of an XML element tag; through unlike an XML element, tag attribute headers are not limited to string keys and values.

  Parameters

  • tag: string

  Returns Record

indexOf

• indexOf(item, index?): number

• Parameters

  • item: ItemLike

  • Optional index: number

  Returns number

interpolateTo

• interpolateTo(that): Interpolator<Record>

• Parameters

  • that: Record

  Returns Interpolator<Record>

• interpolateTo(that): Interpolator<Item>

• Parameters

  • that: Item

  Returns Interpolator<Item>

• interpolateTo(that): Interpolator<Item>

• Parameters

  • that: unknown

  Returns Interpolator<Item>

isAliased

• isAliased(): boolean

• Returns boolean

isArray

• isArray(): boolean

• Returns true if this Record has only [[Value]] members–no Field members.

  Returns boolean

isConstant

• isConstant(): boolean

• Returns true if this Item always [[Item.evaluate evaluates]] to the same Item.

  Returns boolean

isDefinite

• isDefinite(): boolean

• Returns true if this Value is not one of: an empty Record, False, Extant, or Absent.

  Returns boolean

Abstract isEmpty

• isEmpty(): boolean

• Returns true if this Record has no members.

  Returns boolean

isMutable

• isMutable(): boolean

• Returns boolean

isObject

• isObject(): boolean

• Returns true if this Record has only [[Field]] members–no Value members.

  Returns boolean

item

• item(item): Record

• Parameters

  • item: ItemLike

  Returns Record

items

• items(...items): Record

• Parameters

  • Rest ...items: ItemLike[]

  Returns Record

iterator

• iterator(): Cursor<Item>

• Returns Cursor<Item>

lastIndexOf

• lastIndexOf(item, index?): number

• Parameters

  • item: ItemLike

  • Optional index: number

  Returns number

Optional likeType

• likeType(like): void

• Parameters

  • like: readonly ItemLike[] | {
        [key: string]: ValueLike;
    }

  Returns void

prepended

• prepended(...items): Record

• Parameters

  • Rest ...items: ItemLike[]

  Returns Record

Abstract push

• push(...items): number

• Parameters

  • Rest ...items: ItemLike[]

  Returns number

set

• set(key, newValue): Record

• Parameters

  • key: ValueLike

  • newValue: ValueLike

  Returns Record

setAttr

• setAttr(key, newValue): Record

• Parameters

  • key: TextLike

  • newValue: ValueLike

  Returns Record

Abstract setItem

• setItem(index, item): Record

• Replaces the member of this Record at the given index with a new item, returning this Record, if the index is greater than or equal to zero, and less than the [[Record.length length]] of this Record.

  Parameters

  • index: number

  • item: ItemLike

  Returns Record

  Throws

  Error if this is an immutable Record.

  Throws

  RangeError if the index is out of bounds.

setSlot

• setSlot(key, newValue): Record

• Parameters

  • key: ValueLike

  • newValue: ValueLike

  Returns Record

slice

• slice(lower?, upper?): Record

• Parameters

  • Optional lower: number

  • Optional upper: number

  Returns Record

slot

• slot(key, value?): Record

• Parameters

  • key: ValueLike

  • Optional value: ValueLike

  Returns Record

Abstract splice

• splice(start, deleteCount?, ...newItems): Item[]

• Parameters

  • start: number

  • Optional deleteCount: number

  • Rest ...newItems: ItemLike[]

  Returns Item[]

stringValue

• stringValue(): string

• Converts this Value into a string value, if possible; otherwise returns undefined if this Value can't be converted into a string value.

  Returns string
• stringValue<T>(orElse): string | T

• Converts this Value into a string value, if possible; otherwise returns orElse if this Value can't be converted into a string value.

  Type Parameters

  • T

  Parameters

  • orElse: T

  Returns string | T

subRecord

• subRecord(lower?, upper?): Record

• Parameters

  • Optional lower: number

  • Optional upper: number

  Returns Record

substitute

• substitute(interpreter): Record

• Parameters

  • interpreter: InterpreterLike

  Returns Record

tail

• tail(): Record

• Returns a view of all but the first member of this Record, if this Record is non-empty; otherwise returns an empty Record, if this Record is itself empty.

  Returns Record

toArray

• toArray(): ItemLike[]

• Returns ItemLike[]

toLike

• toLike(): ValueLike

• Returns ValueLike

toObject

• toObject(): {
      [key: string]: ValueLike;
  }

• Returns {
      [key: string]: ValueLike;
  }

  • [key: string]: ValueLike

unflattened

• unflattened(): Record

• Returns this Record.

  Returns Record

updated

• updated(key, value): Record

• Parameters

  • key: ValueLike

  • value: ValueLike

  Returns Record

updatedAttr

• updatedAttr(key, value): Record

• Parameters

  • key: TextLike

  • value: ValueLike

  Returns Record

updatedSlot

• updatedSlot(key, value): Record

• Parameters

  • key: ValueLike

  • value: ValueLike

  Returns Record

Static create

• create(initialCapacity?): Record

• Parameters

  • Optional initialCapacity: number

  Returns Record

Static empty

• empty(): Record

• Returns Record

Static fromArray

• fromArray(array): Record

• Parameters

  • array: {
        length?: number;
        [index: number]: ItemLike;
    }

    • [index: number]: ItemLike

    • Optional length?: number

  Returns Record

Static fromLike

• fromLike(value): Record

• Parameters

  • value: RecordLike

  Returns Record

Static fromObject

• fromObject(object): Record

• Parameters

  • object: {
        [key: string]: ValueLike;
    }

    • [key: string]: ValueLike

  Returns Record

Static of

• of(...items): Record

• Parameters

  • Rest ...items: ItemLike[]

  Returns Record