Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

Readonly fieldCount

fieldCount: number

Readonly lower

lower: number

Readonly record

record: RecordMap

Readonly upper

upper: number

Static Readonly AliasedFlag

AliasedFlag: number

Static Readonly ImmutableFlag

ImmutableFlag: number

Accessors

key

  • Returns Value

length

  • get length(): number
  • Returns number

precedence

  • get precedence(): number
  • Returns number

tag

  • get tag(): undefined | string
  • Returns undefined | string

target

  • Returns Value

typeOrder

  • get typeOrder(): number
  • Returns number

valueCount

  • get valueCount(): number
  • Returns number

Methods

alias

  • alias(): void
  • Returns void

and

  • Parameters

    Returns Value

  • Parameters

    Returns Item

appended

  • Parameters

    Returns Record

attr

bind

  • Returns Record

bitwiseAnd

  • Parameters

    Returns Value

  • Parameters

    Returns Item

bitwiseNot

  • Returns Value

bitwiseOr

  • Parameters

    Returns Value

  • Parameters

    Returns Item

bitwiseXor

  • Parameters

    Returns Value

  • Parameters

    Returns Item

body

  • Returns Value

booleanValue

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

  • Type parameters

    • T

    Parameters

    • orElse: T

    Returns boolean | T

branch

  • Returns RecordMap

cast

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

    • T

    Parameters

    • form: Form<T, unknown>

    Returns undefined | T

  • Type parameters

    • T

    • E = T

    Parameters

    • form: Form<T, unknown>
    • orElse: E

    Returns T | E

clear

  • clear(): void
  • Returns void

clearAliased

  • clearAliased(): void
  • Returns void

clearMutable

  • clearMutable(): void
  • Returns void

clone

  • Returns RecordMap

coerce

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

    • T

    Parameters

    • form: Form<T, unknown>

    Returns T

  • Type parameters

    • T

    • E = T

    Parameters

    • form: Form<T, unknown>
    • orElse: E

    Returns T | E

commit

  • Returns RecordMapView

compareTo

  • compareTo(that: unknown): number
  • Parameters

    • that: unknown

    Returns number

concat

  • Parameters

    Returns Record

conditional

debug

  • debug(output: Output<unknown>): void
  • Parameters

    Returns void

delete

  • Parameters

    Returns Item

deleteAliased

  • Parameters

    Returns Item

deleteMutable

  • Parameters

    Returns Item

deleted

  • Parameters

    Returns Record

display

  • display(output: Output<unknown>): void
  • Parameters

    Returns void

divide

  • Parameters

    Returns Value

  • Parameters

    Returns Item

eq

  • Parameters

    Returns Value

  • Parameters

    Returns Item

equals

  • equals(that: unknown): boolean
  • Parameters

    • that: unknown

    Returns boolean

equivalentTo

  • equivalentTo(that: unknown, epsilon?: number): boolean
  • Parameters

    • that: unknown
    • Optional epsilon: number

    Returns boolean

evaluate

filter

  • Parameters

    Returns Selector

flattened

  • Returns Value

forEach

  • forEach<T>(callback: (item: Item, index: number) => void | T): undefined | T
  • forEach<T, S>(callback: (item: Item, index: number) => void | T, thisArg?: S): undefined | T
  • Type parameters

    • T

    Parameters

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

          • item: Item
          • index: number

          Returns void | T

    Returns undefined | T

  • Type parameters

    • T

    • S

    Parameters

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

          • item: Item
          • index: number

          Returns void | T

    • Optional thisArg: S

    Returns undefined | T

ge

  • Parameters

    Returns Value

  • Parameters

    Returns Item

get

  • Parameters

    Returns Value

getAttr

  • Parameters

    Returns Value

getField

  • Parameters

    Returns undefined | Field

getItem

  • Parameters

    Returns Item

getSlot

  • Parameters

    Returns Value

gt

  • Parameters

    Returns Value

  • Parameters

    Returns Item

has

  • Parameters

    Returns boolean

hashCode

  • hashCode(): number
  • Returns number

head

  • Returns Item

header

  • header(tag: string): Value
  • Parameters

    • tag: string

    Returns Value

headers

  • headers(tag: string): undefined | Record
  • Parameters

    • tag: string

    Returns undefined | Record

indexOf

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

    • item: AnyItem
    • Optional index: number

    Returns number

interpolateTo

inverse

  • Returns Value

invoke

  • Parameters

    Returns Item

isAliased

  • isAliased(): boolean
  • Returns boolean

isArray

  • isArray(): boolean
  • Returns boolean

isConstant

  • isConstant(): boolean
  • Returns boolean

isDefined

  • isDefined(): boolean
  • Returns boolean

isDefinite

  • isDefinite(): boolean
  • Returns boolean

isDistinct

  • isDistinct(): boolean
  • Returns boolean

isEmpty

  • isEmpty(): boolean
  • Returns boolean

isMutable

  • isMutable(): boolean
  • Returns boolean

isObject

  • isObject(): boolean
  • Returns boolean

item

  • Parameters

    Returns RecordMapView

items

  • Parameters

    Returns RecordMapView

iterator

  • Returns Cursor<Item>

keyEquals

  • keyEquals(key: unknown): boolean
  • Parameters

    • key: unknown

    Returns boolean

lambda

  • Parameters

    Returns Value

lastIndexOf

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

    • item: AnyItem
    • Optional index: number

    Returns number

le

  • Parameters

    Returns Value

  • Parameters

    Returns Item

lt

  • Parameters

    Returns Value

  • Parameters

    Returns Item

max

  • Parameters

    Returns Item

min

  • Parameters

    Returns Item

minus

  • Parameters

    Returns Value

  • Parameters

    Returns Item

modulo

  • Parameters

    Returns Value

  • Parameters

    Returns Item

ne

  • Parameters

    Returns Value

  • Parameters

    Returns Item

negative

  • Returns Value

not

  • Returns Value

numberValue

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

  • Type parameters

    • T

    Parameters

    • orElse: T

    Returns number | T

or

  • Parameters

    Returns Value

  • Parameters

    Returns Item

plus

  • Parameters

    Returns Value

  • Parameters

    Returns Item

positive

  • Returns Value

prepended

  • Parameters

    Returns Record

push

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

    Returns number

pushAliased

  • pushAliased(...newItems: AnyItem[]): void
  • Parameters

    Returns void

pushMutable

  • pushMutable(...newItems: AnyItem[]): void
  • Parameters

    Returns void

set

setAttr

setItem

  • Parameters

    Returns RecordMapView

setItemAliased

  • setItemAliased(index: number, newItem: Item): void
  • Parameters

    • index: number
    • newItem: Item

    Returns void

setItemMutable

  • setItemMutable(index: number, newItem: Item): void
  • Parameters

    • index: number
    • newItem: Item

    Returns void

setSlot

slice

  • slice(lower?: number, upper?: number): Record
  • Parameters

    • Optional lower: number
    • Optional upper: number

    Returns Record

slot

splice

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

    • start: number
    • Optional deleteCount: number
    • Rest ...newItems: AnyItem[]

    Returns Item[]

stringValue

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

  • Type parameters

    • T

    Parameters

    • orElse: T

    Returns string | T

subRecord

  • subRecord(lower?: number, upper?: number): Record
  • Parameters

    • Optional lower: number
    • Optional upper: number

    Returns Record

substitute

tail

  • Returns Record

times

  • Parameters

    Returns Value

  • Parameters

    Returns Item

toAny

  • Returns AnyValue

toArray

  • Returns AnyItem[]

toObject

  • toObject(): {}
  • Returns {}

toRecon

  • toRecon(): string
  • Returns string

toReconBlock

  • toReconBlock(): string
  • Returns string

toString

  • toString(): string
  • Returns string

toValue

  • Returns Value

unflattened

  • Returns Record

updated

updatedAttr

updatedSlot

Static absent

  • Returns Value

Static builder

Static create

  • create(initialCapacity?: number): Record
  • Parameters

    • Optional initialCapacity: number

    Returns Record

Static empty

  • Returns Record

Static expand

  • expand(n: number): number
  • Parameters

    • n: number

    Returns number

Static extant

  • Returns Value

Static fromAny

  • Parameters

    Returns Record

Static fromArray

  • fromArray(array: { length?: number }): Record
  • Parameters

    • array: { length?: number }
      • [index: number]: AnyItem
      • Optional length?: number

    Returns Record

Static fromObject

  • fromObject(object: {}): Record
  • Parameters

    Returns Record

Static globalScope

  • globalScope(): Item
  • Returns Item

Static of

  • Parameters

    Returns Record

Generated using TypeDoc