Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Accessors

key

  • get key(): Value

length

  • get length(): number

Methods

alias

  • alias(): void

and

appended

attr

bind

bitwiseAnd

bitwiseNot

  • bitwiseNot(): Value

bitwiseOr

bitwiseXor

body

  • body(): Value

booleanValue

  • booleanValue(): boolean | undefined
  • booleanValue<T>(orElse: T): boolean | T

branch

cast

  • cast<T>(form: Form<T, unknown>): T | undefined
  • cast<T, E>(form: Form<T, unknown>, orElse: E): T | E

Abstract clear

  • clear(): void

clone

coerce

  • coerce<T>(form: Form<T, unknown>): T
  • coerce<T, E>(form: Form<T, unknown>, orElse: E): T | E

commit

  • commit(): this

compareTo

  • compareTo(that: Item): 0 | 1 | -1

concat

conditional

debug

Abstract delete

deleted

display

  • display(output: Output): void

divide

eq

equals

  • equals(that: unknown): boolean

evaluate

fieldCount

  • fieldCount(): number

filter

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, S>(callback: function, thisArg?: S): T | undefined

ge

get

getAttr

getField

Abstract getItem

  • getItem(index: AnyNum): Item

getSlot

gt

has

hashCode

  • hashCode(): number

head

  • head(): Item

header

  • header(tag: string): 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: string): Record | undefined

indexOf

  • indexOf(item: AnyItem, index?: number): number

inverse

  • inverse(): Value

invoke

  • invoke(args: Value): Item

isAliased

  • isAliased(): boolean

isArray

  • isArray(): boolean

isConstant

  • isConstant(): boolean

isDefined

  • isDefined(): boolean

isDistinct

  • isDistinct(): boolean

Abstract isEmpty

  • isEmpty(): boolean

isMutable

  • isMutable(): boolean

isObject

  • isObject(): boolean

item

items

iterator

keyEquals

  • keyEquals(key: unknown): boolean

lambda

  • lambda(template: Value): Value

lastIndexOf

  • lastIndexOf(item: AnyItem, index?: undefined | number): number

le

lt

max

  • max(that: Item): Item

min

  • min(that: Item): Item

minus

modulo

ne

negative

  • negative(): Value

not

  • not(): Value

numberValue

  • numberValue(): number | undefined
  • numberValue<T>(orElse: T): number | T

or

plus

positive

  • positive(): Value

prepended

Abstract push

  • push(...items: AnyItem[]): number

set

setAttr

Abstract setItem

  • setItem(index: number, item: AnyItem): this
  • Replaces the member of this Record at the given index with a new item, returning {@code this} {@code Record}, if the {@code index} is greater than or equal to zero, and less than the length of this {@code Record}.

    throws

    Error if this is an immutable Record.

    throws

    RangeError if the index is out of bounds.

    Parameters

    Returns this

setSlot

slice

  • slice(lower?: undefined | number, upper?: undefined | number): Record

slot

Abstract splice

  • splice(start: number, deleteCount?: undefined | number, ...newItems: AnyItem[]): Item[]

stringValue

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

subRecord

  • subRecord(lower?: undefined | number, upper?: undefined | number): Record

substitute

tag

  • tag(): string | undefined
  • 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 | undefined

tail

target

  • target(): Value
  • Returns the 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

times

toAny

toArray

toObject

  • toObject(): object

toRecon

  • toRecon(): string

toReconBlock

  • toReconBlock(): string

toString

  • toString(): string

toValue

  • toValue(): Value

typeOrder

  • typeOrder(): number

unflattened

updated

updatedAttr

updatedSlot

valueCount

  • valueCount(): number

Static absent

  • absent(): Value

Static builder

Static create

  • create(initialCapacity?: undefined | number): Record

Static empty

Static extant

  • extant(): Value

Static fromAny

Static fromArray

  • fromArray(array: object): Record

Static fromObject

  • fromObject(object: object): Record

Static globalScope

  • globalScope(): Item

Static of

Static parseRecon

  • parseRecon(recon: string): Value