Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RecordModel

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

key

  • get key(): Value

length

  • get length(): number

Methods

alias

  • alias(): void

and

appended

attr

bind

bindOutput

bindValue

  • bindValue(key: Value, expr: Value): void

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

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

compile

  • compile(record: Record): void

compileField

  • compileField(field: Field, index: number): void

compileItem

  • compileItem(item: Item, index: number): void

compileValue

  • compileValue(value: Value, index: number): void

concat

conditional

debug

delete

deleted

Protected didInvalidateInput

  • didInvalidateInput(): void

Protected didInvalidateInputKey

  • didInvalidateInputKey(key: Value, effect: KeyEffect): void

Protected didReconcileInput

  • didReconcileInput(version: number): void

Protected didReconcileInputKey

  • didReconcileInputKey(key: Value, effect: KeyEffect, version: number): void

disconnectInputs

  • disconnectInputs(): void

disconnectOutputs

  • disconnectOutputs(): void

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

forEach

  • forEach<T, S>(callback: function, thisArg?: S): T | undefined

ge

get

getAttr

getField

getItem

  • getItem(index: AnyNum): Item

getSlot

gt

has

hasOwn

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?: undefined | number): number

invalidateInput

  • invalidateInput(): void

invalidateInputKey

  • invalidateInputKey(key: Value, effect: KeyEffect): void

inverse

  • inverse(): Value

invoke

  • invoke(args: Value): Item

isAliased

  • isAliased(): boolean

isArray

  • isArray(): boolean

isConstant

  • isConstant(): boolean

isDefined

  • isDefined(): boolean

isDistinct

  • isDistinct(): boolean

isEmpty

  • isEmpty(): boolean

isMutable

  • isMutable(): boolean

isObject

  • isObject(): boolean

item

items

iterator

keyEquals

  • keyEquals(key: unknown): boolean

keyIterator

  • keyIterator(): Cursor<Value>

lambda

  • lambda(template: Value): Value

lastIndexOf

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

le

lt

map

materialize

  • materialize(record: Record): void

materializeField

  • materializeField(field: Field): void

materializeItem

  • materializeItem(item: Item): void

materializeValue

  • materializeValue(value: Value): void

max

  • max(that: Item): Item

memoize

min

  • min(that: Item): Item

minus

modulo

ne

negative

  • negative(): Value

not

  • not(): Value

numberValue

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

Protected onInvalidateInput

  • onInvalidateInput(): void

Protected onInvalidateInputKey

  • onInvalidateInputKey(key: Value, effect: KeyEffect): void

Protected onReconcileInput

  • onReconcileInput(version: number): void

Protected onReconcileInputKey

  • onReconcileInputKey(key: Value, effect: KeyEffect, version: number): void

or

outlet

  • outlet(key: Value | string): Outlet<Value>

outputIterator

plus

positive

  • positive(): Value

prepended

push

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

reconcileInput

  • reconcileInput(version: number): void

reconcileInputKey

  • reconcileInputKey(key: Value, version: number): void

reduce

  • reduce<U>(identity: U, accumulator: function, combiner: function): Outlet<U>

set

setAttr

setItem

  • setItem(index: number, newItem: AnyItem): this

setSlot

slice

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

slot

splice

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

streamletContext

streamletScope

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

times

toAny

toArray

toObject

  • toObject(): object

toRecon

  • toRecon(): string

toReconBlock

  • toReconBlock(): string

toString

  • toString(): string

toValue

  • toValue(): Value

transmute

transmuteField

transmuteItem

  • transmuteItem(item: Item, transmuter: Transmuter | null): Item

transmuteModel

transmuteValue

  • transmuteValue(oldValue: Value, transmuter: Transmuter | null): Value

typeOrder

  • typeOrder(): number

unbindOutput

unbindOutputs

  • unbindOutputs(): void

unflattened

updated

updatedAttr

updatedSlot

valueCount

  • valueCount(): number

watch

Protected willInvalidateInput

  • willInvalidateInput(): void

Protected willInvalidateInputKey

  • willInvalidateInputKey(key: Value, effect: KeyEffect): void

Protected willReconcileInput

  • willReconcileInput(version: number): void

Protected willReconcileInputKey

  • willReconcileInputKey(key: Value, effect: KeyEffect, version: number): void

Static absent

  • absent(): Value

Static builder

Static create

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

Static empty

Static extant

  • extant(): Value

Static from

Static fromAny

Static fromArray

  • fromArray(array: object): Record

Static fromObject

  • fromObject(object: object): Record

Static globalScope

Static of

Static parseRecon

  • parseRecon(recon: string): Value