Class Field

Hierarchy

Item
- Field
  - Attr
  - Slot

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Field(): Field

Overrides Item.constructor
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:13
Returns Field

Properties

Readonly Abstract key

key: Value

Readonly Abstract typeOrder

typeOrder: number

Readonly Abstract value

value: Value

Static Readonly ImmutableFlag

ImmutableFlag: number

Accessors

length

get length(): number

- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:32
Returns number

precedence

get precedence(): number

- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:95
Returns number

tag

get tag(): undefined | string

- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:23
Returns undefined | string

target

get target(): Value

- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:24
Returns Value

Methods

Abstract alias

alias(): void

Inherited from Item.alias
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:91
Returns void

and

and(that: Field): Field
and(that: AnyItem): Item

Overrides Item.and
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:44
Parameters
- that: Field
Returns Field
Overrides Item.and
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:45
Parameters
- that: AnyItem
Returns Item

appended

appended(...items: AnyItem[]): Record

Inherited from Item.appended
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:45
Parameters
- Rest ...items: AnyItem[]
Returns Record

Abstract bitwiseAnd

bitwiseAnd(that: AnyItem): Item

Inherited from Item.bitwiseAnd
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:54
Parameters
- that: AnyItem
Returns Item

Abstract bitwiseNot

bitwiseNot(): Item

Inherited from Item.bitwiseNot
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:67
Returns Item

Abstract bitwiseOr

bitwiseOr(that: AnyItem): Item

Inherited from Item.bitwiseOr
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:52
Parameters
- that: AnyItem
Returns Item

Abstract bitwiseXor

bitwiseXor(that: AnyItem): Item

Inherited from Item.bitwiseXor
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:53
Parameters
- that: AnyItem
Returns Item

body

body(): Value

Overrides Item.body
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:31
Returns Value

booleanValue

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

Overrides Item.booleanValue
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:51
Returns undefined | boolean
Overrides Item.booleanValue
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:52
Type parameters
- T
Parameters
- orElse: T
Returns boolean | T

Abstract branch

branch(): Field

Overrides Item.branch
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:54
Returns Field

cast

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

Inherited from Item.cast
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:84
Type parameters
- T
Parameters
- form: Form<T, unknown>
Returns undefined | T
Inherited from Item.cast
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:85
Type parameters
- T
- E = T
Parameters
- form: Form<T, unknown>
- orElse: E
Returns T | E

Abstract clone

clone(): Field

Overrides Item.clone
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:55
Returns Field

coerce

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

Inherited from Item.coerce
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:86
Type parameters
- T
Parameters
- form: Form<T, unknown>
Returns T
Inherited from Item.coerce
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:87
Type parameters
- T
- E = T
Parameters
- form: Form<T, unknown>
- orElse: E
Returns T | E

Abstract commit

commit(): Field

Overrides Item.commit
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:56
Returns Field

Abstract compareTo

compareTo(that: unknown): number

Inherited from Item.compareTo
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:102
Parameters
- that: unknown
Returns number

concat

concat(...items: AnyItem[]): Record

Inherited from Item.concat
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:48
Parameters
- Rest ...items: AnyItem[]
Returns Record

conditional

conditional(thenTerm: Field, elseTerm: Field): Field
conditional(thenTerm: AnyItem, elseTerm: AnyItem): Item

Overrides Item.conditional
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:40
Parameters
- thenTerm: Field
- elseTerm: Field
Returns Field
Overrides Item.conditional
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:41
Parameters
- thenTerm: AnyItem
- elseTerm: AnyItem
Returns Item

Abstract debug

debug(output: Output<unknown>): void

Inherited from Item.debug
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:107
Parameters
- output: Output<unknown>
Returns void

deleted

deleted(key: AnyValue): Field

Overrides Item.deleted
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:39
Parameters
- key: AnyValue
Returns Field

display

display(output: Output<unknown>): void

Inherited from Item.display
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:108
Parameters
- output: Output<unknown>
Returns void

Abstract divide

divide(that: AnyItem): Item

Inherited from Item.divide
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:64
Parameters
- that: AnyItem
Returns Item

eq

eq(that: AnyItem): Item

Inherited from Item.eq
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:57
Parameters
- that: AnyItem
Returns Item

Abstract equals

equals(that: unknown): boolean

Inherited from Item.equals
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:105
Parameters
- that: unknown
Returns boolean

Abstract equivalentTo

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

Inherited from Item.equivalentTo
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:103
Parameters
- that: unknown
- Optional epsilon: number
Returns boolean

evaluate

evaluate(interpreter: AnyInterpreter): Item

Inherited from Item.evaluate
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:76
Parameters
- interpreter: AnyInterpreter
Returns Item

filter

filter(predicate?: AnyItem): Selector

Inherited from Item.filter
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:73
Parameters
- Optional predicate: AnyItem
Returns Selector

flattened

flattened(): Value

Overrides Item.flattened
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:25
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

Inherited from Item.forEach
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:96
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
Inherited from Item.forEach
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:97
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
- thisArg: S
Returns undefined | T

ge

ge(that: AnyItem): Item

Inherited from Item.ge
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:59
Parameters
- that: AnyItem
Returns Item

get

get(key: AnyValue): Value

Overrides Item.get
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:34
Parameters
- key: AnyValue
Returns Value

getAttr

getAttr(key: AnyText): Value

Overrides Item.getAttr
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:35
Parameters
- key: AnyText
Returns Value

getField

getField(key: AnyValue): undefined | Field

Overrides Item.getField
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:37
Parameters
- key: AnyValue
Returns undefined | Field

getItem

getItem(index: AnyNum): Item

Overrides Item.getItem
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:38
Parameters
- index: AnyNum
Returns Item

getSlot

getSlot(key: AnyValue): Value

Overrides Item.getSlot
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:36
Parameters
- key: AnyValue
Returns Value

gt

gt(that: AnyItem): Item

Inherited from Item.gt
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:60
Parameters
- that: AnyItem
Returns Item

has

has(key: AnyValue): boolean

Overrides Item.has
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:33
Parameters
- key: AnyValue
Returns boolean

Abstract hashCode

hashCode(): number

Inherited from Item.hashCode
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:106
Returns number

head

head(): Item

Overrides Item.head
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:29
Returns Item

header

header(tag: string): Value

Overrides Item.header
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:27
Parameters
- tag: string
Returns Value

headers

headers(tag: string): undefined | Record

Overrides Item.headers
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:28
Parameters
- tag: string
Returns undefined | Record

interpolateTo

interpolateTo(that: Field): Interpolator<Field>
interpolateTo(that: Item): Interpolator<Item>
interpolateTo(that: unknown): null | Interpolator<Item>

Overrides Item.interpolateTo
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:57
Parameters
- that: Field
Returns Interpolator<Field>
Overrides Item.interpolateTo
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:58
Parameters
- that: Item
Returns Interpolator<Item>
Overrides Item.interpolateTo
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:59
Parameters
- that: unknown
Returns null | Interpolator<Item>

Abstract inverse

inverse(): Item

Inherited from Item.inverse
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:70
Returns Item

invoke

invoke(args: Value): Item

Inherited from Item.invoke
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:71
Parameters
- args: Value
Returns Item

Abstract isAliased

isAliased(): boolean

Inherited from Item.isAliased
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:89
Returns boolean

Abstract isConstant

isConstant(): boolean

Inherited from Item.isConstant
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:23
Returns boolean

isDefined

isDefined(): boolean

Overrides Item.isDefined
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:15
Returns boolean

isDefinite

isDefinite(): boolean

Overrides Item.isDefinite
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:17
Returns boolean

isDistinct

isDistinct(): boolean

Overrides Item.isDistinct
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:16
Returns boolean

Abstract isMutable

isMutable(): boolean

Inherited from Item.isMutable
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:90
Returns boolean

iterator

iterator(): Cursor<Item>

Inherited from Item.iterator
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:98
Returns Cursor<Item>

Abstract keyEquals

keyEquals(key: unknown): boolean

Inherited from Item.keyEquals
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:104
Parameters
- key: unknown
Returns boolean

lambda

lambda(template: Value): Value

Overrides Item.lambda
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:46
Parameters
- template: Value
Returns Value

le

le(that: AnyItem): Item

Inherited from Item.le
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:56
Parameters
- that: AnyItem
Returns Item

lt

lt(that: AnyItem): Item

Inherited from Item.lt
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:55
Parameters
- that: AnyItem
Returns Item

max

max(that: Item): Item

Inherited from Item.max
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:74
Parameters
- that: Item
Returns Item

min

min(that: Item): Item

Inherited from Item.min
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:75
Parameters
- that: Item
Returns Item

Abstract minus

minus(that: AnyItem): Item

Inherited from Item.minus
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:62
Parameters
- that: AnyItem
Returns Item

Abstract modulo

modulo(that: AnyItem): Item

Inherited from Item.modulo
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:65
Parameters
- that: AnyItem
Returns Item

ne

ne(that: AnyItem): Item

Inherited from Item.ne
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:58
Parameters
- that: AnyItem
Returns Item

Abstract negative

negative(): Item

Inherited from Item.negative
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:68
Returns Item

Abstract not

not(): Item

Inherited from Item.not
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:66
Returns Item

numberValue

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

Overrides Item.numberValue
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:49
Returns undefined | number
Overrides Item.numberValue
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:50
Type parameters
- T
Parameters
- orElse: T
Returns number | T

or

or(that: Field): Field
or(that: AnyItem): Item

Overrides Item.or
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:42
Parameters
- that: Field
Returns Field
Overrides Item.or
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:43
Parameters
- that: AnyItem
Returns Item

Abstract plus

plus(that: AnyItem): Item

Inherited from Item.plus
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:61
Parameters
- that: AnyItem
Returns Item

Abstract positive

positive(): Item

Inherited from Item.positive
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:69
Returns Item

prepended

prepended(...items: AnyItem[]): Record

Inherited from Item.prepended
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:46
Parameters
- Rest ...items: AnyItem[]
Returns Record

Abstract setValue

setValue(value: AnyValue): Value

- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:20
Parameters
- value: AnyValue
Returns Value

stringValue

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

Overrides Item.stringValue
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:47
Returns undefined | string
Overrides Item.stringValue
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:48
Type parameters
- T
Parameters
- orElse: T
Returns string | T

substitute

substitute(interpreter: AnyInterpreter): Item

Inherited from Item.substitute
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:77
Parameters
- interpreter: AnyInterpreter
Returns Item

tail

tail(): Record

Overrides Item.tail
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:30
Returns Record

Abstract times

times(that: AnyItem): Item

Inherited from Item.times
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:63
Parameters
- that: AnyItem
Returns Item

Abstract toAny

toAny(): AnyField

Overrides Item.toAny
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:53
Returns AnyField

toRecon

toRecon(): string

Inherited from Item.toRecon
- Defined in swim-system-js/swim-core-js/@swim/recon/lib/main/index.d.ts:6
Returns string

toReconBlock

toReconBlock(): string

Inherited from Item.toReconBlock
- Defined in swim-system-js/swim-core-js/@swim/recon/lib/main/index.d.ts:7
Returns string

toString

toString(): string

Inherited from Item.toString
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:109
Returns string

toValue

toValue(): Value

Overrides Item.toValue
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:22
Returns Value

unflattened

unflattened(): Record

Overrides Item.unflattened
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:26
Returns Record

updated

updated(key: AnyValue, value: AnyValue): Record

Inherited from Item.updated
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:42
Parameters
- key: AnyValue
- value: AnyValue
Returns Record

updatedAttr

updatedAttr(key: AnyText, value: AnyValue): Record

Inherited from Item.updatedAttr
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:43
Parameters
- key: AnyText
- value: AnyValue
Returns Record

updatedSlot

updatedSlot(key: AnyValue, value: AnyValue): Record

Inherited from Item.updatedSlot
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:44
Parameters
- key: AnyValue
- value: AnyValue
Returns Record

Abstract updatedValue

updatedValue(value: AnyValue): Field

- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:21
Parameters
- value: AnyValue
Returns Field

Static absent

absent(): Item

Inherited from Item.absent
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:112
Returns Item

Static empty

empty(): Item

Inherited from Item.empty
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:110
Returns Item

Static extant

extant(): Item

Inherited from Item.extant
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:111
Returns Item

Static fromAny

fromAny(field: AnyField): Field

Overrides Item.fromAny
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:62
Parameters
- field: AnyField
Returns Field

Static globalScope

globalScope(): Item

Inherited from Item.globalScope
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:114
Returns Item

Static of

of(key: AnyValue, value?: AnyValue): Field

- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:61
Parameters
- key: AnyValue
- Optional value: AnyValue
Returns Field

Generated using TypeDoc