Class FieldAbstract

Abstract Readonly key

Abstract Readonly value

length

• get length(): number

• Always returns 0 because a Field can't be a Record, so it can't contain any members.

  Returns number

tag

• get tag(): string

• Always returns undefined because a Field can't be a Record, so it can't have a first member Attr whose key string could be returned.

  Returns string

target

• get target(): Value

• Always returns the value component of this Field.

  Returns Value

and

• and(that): Field

• Parameters

  • that: Field

  Returns Field

• and(that): Item

• Parameters

  • that: ItemLike

  Returns Item

body

• body(): Value

• Always returns [[Absent]] because a Field can't be a Record, so it can't have any non-first members to flatten, and because a Field isn't a distinct Value, so it can't return Extant.

  Returns Value

booleanValue

• booleanValue(): boolean

• Converts the value of this Field into a boolean value, if possible.

  Returns boolean

  Throws

  Error if the value of this Field can't be converted into a boolean value.

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

• Converts the value of this Field into a boolean value, if possible; otherwise returns orElse if the value of this Field can't be converted into a boolean value.

  Type Parameters

  • T

  Parameters

  • orElse: T

  Returns boolean | T

Abstract branch

• branch(): Field

• Returns Field

Abstract clone

• clone(): Field

• Returns Field

Abstract commit

• commit(): Field

• Returns Field

conditional

• conditional(thenTerm, elseTerm): Field

• Parameters

  • thenTerm: Field

  • elseTerm: Field

  Returns Field

• conditional(thenTerm, elseTerm): Item

• Parameters

  • thenTerm: ItemLike

  • elseTerm: ItemLike

  Returns Item

deleted

• deleted(key): Field

• Parameters

  • key: ValueLike

  Returns Field

flattened

• flattened(): Value

• Always returns [[Absent]] because a Field can't be flattened into a Value.

  Returns Value

get

• get(key): Value

• Always returns [[Absent]] because a Field can't be a Record, so it can't have a Field member whose key is equal to the given key.

  Parameters

  • key: ValueLike

  Returns Value

getAttr

• getAttr(key): Value

• Always returns [[Absent]] because a Field can't be a Record, so it can't have an Attr member whose key is equal to the given key.

  Parameters

  • key: TextLike

  Returns Value

getField

• getField(key): Field

• Always returns undefined because a Field can't be a Record, so it can't have a Field member whose key is equal to the given key.

  Parameters

  • key: ValueLike

  Returns Field

getItem

• getItem(index): Item

• Always returns [[Absent]] because a Field can't be a Record, so it can't have a member at the given index.

  Parameters

  • index: NumLike

  Returns Item

getSlot

• getSlot(key): Value

• Always returns [[Absent]] because a Field can't be a Record, so it can't have a Slot member whose key is equal to the given key.

  Parameters

  • key: ValueLike

  Returns Value

has

• has(key): boolean

• Always returns false because a Field can't be a Record, so it can't have a Field member whose key is equal to the given key.

  Parameters

  • key: ValueLike

  Returns boolean

head

• head(): Item

• Always returns [[Absent]] because a Field can't be a Record, so it can't have a first member.

  Returns Item

header

• header(tag): Value

• Always returns [[Absent]] because a Field can't be a Record, so it can't have a head Attr whose value could be returned if its key were equal to the tag.

  Parameters

  • tag: string

  Returns Value

headers

• headers(tag): Record

• Always returns undefined because a Field can't be a Record, so it can't have a head Attr whose value could be returned as a Record if its key were equal to the tag.

  Parameters

  • tag: string

  Returns Record

interpolateTo

• interpolateTo(that): Interpolator<Field>

• Parameters

  • that: Field

  Returns Interpolator<Field>

• interpolateTo(that): Interpolator<Item>

• Parameters

  • that: Item

  Returns Interpolator<Item>

• interpolateTo(that): Interpolator<Item>

• Parameters

  • that: unknown

  Returns Interpolator<Item>

isDefined

• isDefined(): boolean

• Always returns true because a Field can never be [[Absent]].

  Returns boolean

isDefinite

• isDefinite(): boolean

• Always returns true because a Field cannot be one of: an empty Record, False, Extant, or Absent.

  Returns boolean

isDistinct

• isDistinct(): boolean

• Always returns true because a Field can be neither [[Extant]] nor [[Absent]].

  Returns boolean

lambda

• lambda(template): Value

• Parameters

  • template: Value

  Returns Value

Optional likeType

• likeType(like): void

• Parameters

  • like: {
        $key: ValueLike;
        $value: ValueLike;
    } | {
        [key: string]: ValueLike;
    }

  Returns void

numberValue

• numberValue(): number

• Converts the value of this Field into a number value, if possible.

  Returns number

  Throws

  Error if the value of this Field can't be converted into a number value.

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

• Converts the value of this Field into a number value, if possible; otherwise returns orElse if the value of this Field can't be converted into a number value.

  Type Parameters

  • T

  Parameters

  • orElse: T

  Returns number | T

or

• or(that): Field

• Parameters

  • that: Field

  Returns Field

• or(that): Item

• Parameters

  • that: ItemLike

  Returns Item

Abstract setValue

• setValue(value): Value

• Sets the value of this Field to the new value, returning the old value.

  Parameters

  • value: ValueLike

  Returns Value

  Throws

  Error if this Field is immutable.

stringValue

• stringValue(): string

• Converts the value of this Field into a string value, if possible.

  Returns string

  Throws

  Error if the value of this Field can't be converted into a string value.

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

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

  Type Parameters

  • T

  Parameters

  • orElse: T

  Returns string | T

tail

• tail(): Record

• Always returns an empty Record because a Field can't itself be a Record, so it can't have any non-first members.

  Returns Record

Abstract toLike

• toLike(): FieldLike

• Returns FieldLike

toValue

• toValue(): Value

• Returns the value component of this Field.

  Returns Value

unflattened

• unflattened(): Record

• Returns a Record containing just this Field.

  Returns Record

Abstract updatedValue

• updatedValue(value): Field

• Returns a copy of this Field with the updated value.

  Parameters

  • value: ValueLike

  Returns Field

Static fromLike

• fromLike(field): Field

• Parameters

  • field: FieldLike

  Returns Field

Static of

• of(key, value?): Field

• Parameters

  • key: ValueLike

  • Optional value: ValueLike

  Returns Field