Class Attr

Hierarchy

Field
- Attr

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Attr(key: Text, value: Value, flags?: number): Attr

Overrides Field.constructor
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:8
Parameters
- key: Text
- value: Value
- Optional flags: number
Returns Attr

Properties

Readonly flags

flags: number

Readonly key

key: Text

Readonly 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

name

get name(): string

- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:11
Returns string

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

typeOrder

get typeOrder(): number

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

Methods

alias

alias(): void

Overrides Field.alias
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:35
Returns void

and

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

Inherited from Field.and
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:44
Parameters
- that: Field
Returns Field
Inherited from Field.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 Field.appended
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:45
Parameters
- Rest ...items: AnyItem[]
Returns Record

bitwiseAnd

bitwiseAnd(that: AnyItem): Item

Overrides Field.bitwiseAnd
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:19
Parameters
- that: AnyItem
Returns Item

bitwiseNot

bitwiseNot(): Item

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

bitwiseOr

bitwiseOr(that: AnyItem): Item

Overrides Field.bitwiseOr
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:17
Parameters
- that: AnyItem
Returns Item

bitwiseXor

bitwiseXor(that: AnyItem): Item

Overrides Field.bitwiseXor
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:18
Parameters
- that: AnyItem
Returns Item

body

body(): Value

Inherited from Field.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

Inherited from Field.booleanValue
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:51
Returns undefined | boolean
Inherited from Field.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

branch

branch(): Attr

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

cast

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

Inherited from Field.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 Field.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

clone

clone(): Attr

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

coerce

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

Inherited from Field.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 Field.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

commit

commit(): Attr

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

compareTo

compareTo(that: Item): number

Overrides Field.compareTo
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:43
Parameters
- that: Item
Returns number

concat

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

Inherited from Field.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

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

debug

debug(output: Output<unknown>): void

Overrides Field.debug
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:48
Parameters
- output: Output<unknown>
Returns void

deleted

deleted(key: AnyValue): Field

Inherited from Field.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

Overrides Field.display
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:49
Parameters
- output: Output<unknown>
Returns void

divide

divide(that: AnyItem): Item

Overrides Field.divide
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:23
Parameters
- that: AnyItem
Returns Item

eq

eq(that: AnyItem): Item

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

equals

equals(that: unknown): boolean

Overrides Field.equals
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:46
Parameters
- that: unknown
Returns boolean

equivalentTo

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

Overrides Field.equivalentTo
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:44
Parameters
- that: unknown
- Optional epsilon: number
Returns boolean

evaluate

evaluate(interpreter: AnyInterpreter): Item

Overrides Field.evaluate
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:30
Parameters
- interpreter: AnyInterpreter
Returns Item

filter

filter(predicate?: AnyItem): Selector

Inherited from Field.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

Inherited from Field.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 Field.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 Field.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 Field.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

Inherited from Field.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

Inherited from Field.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

Inherited from Field.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

Inherited from Field.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

Inherited from Field.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 Field.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

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

hashCode

hashCode(): number

Overrides Field.hashCode
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:47
Returns number

head

head(): Item

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

header

header(tag: string): Value

Inherited from Field.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

Inherited from Field.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: Attr): Interpolator<Attr>
interpolateTo(that: Item): Interpolator<Item>
interpolateTo(that: unknown): null | Interpolator<Item>

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

inverse

inverse(): Item

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

invoke

invoke(args: Value): Item

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

isAliased

isAliased(): boolean

Overrides Field.isAliased
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:33
Returns boolean

isConstant

isConstant(): boolean

Overrides Field.isConstant
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:10
Returns boolean

isDefined

isDefined(): boolean

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

isDefinite

isDefinite(): boolean

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

isDistinct

isDistinct(): boolean

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

isMutable

isMutable(): boolean

Overrides Field.isMutable
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:34
Returns boolean

iterator

iterator(): Cursor<Item>

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

keyEquals

keyEquals(key: unknown): boolean

Overrides Field.keyEquals
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:45
Parameters
- key: unknown
Returns boolean

lambda

lambda(template: Value): Value

Inherited from Field.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 Field.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 Field.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 Field.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 Field.min
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:75
Parameters
- that: Item
Returns Item

minus

minus(that: AnyItem): Item

Overrides Field.minus
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:21
Parameters
- that: AnyItem
Returns Item

modulo

modulo(that: AnyItem): Item

Overrides Field.modulo
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:24
Parameters
- that: AnyItem
Returns Item

ne

ne(that: AnyItem): Item

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

negative

negative(): Item

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

not

not(): Item

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

numberValue

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

Inherited from Field.numberValue
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:49
Returns undefined | number
Inherited from Field.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

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

plus

plus(that: AnyItem): Item

Overrides Field.plus
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:20
Parameters
- that: AnyItem
Returns Item

positive

positive(): Item

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

prepended

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

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

setValue

setValue(newValue: Value): Value

Overrides Field.setValue
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:15
Parameters
- newValue: Value
Returns Value

stringValue

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

Inherited from Field.stringValue
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Field.d.ts:47
Returns undefined | string
Inherited from Field.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

Overrides Field.substitute
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:31
Parameters
- interpreter: AnyInterpreter
Returns Item

tail

tail(): Record

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

times

times(that: AnyItem): Item

Overrides Field.times
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:22
Parameters
- that: AnyItem
Returns Item

toAny

toAny(): AnyField

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

toRecon

toRecon(): string

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

toReconBlock

toReconBlock(): string

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

toString

toString(): string

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

toValue

toValue(): Value

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

unflattened

unflattened(): Record

Inherited from Field.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 Field.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 Field.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 Field.updatedSlot
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:44
Parameters
- key: AnyValue
- value: AnyValue
Returns Record

updatedValue

updatedValue(value: Value): Attr

Overrides Field.updatedValue
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:16
Parameters
- value: Value
Returns Attr

Static absent

absent(): Item

Inherited from Field.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 Field.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 Field.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

Inherited from Field.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 Field.globalScope
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Item.d.ts:114
Returns Item

Static of

of(key: AnyText, value?: AnyValue): Attr

Overrides Field.of
- Defined in swim-system-js/swim-core-js/@swim/structure/lib/main/Attr.d.ts:50
Parameters
- key: AnyText
- Optional value: AnyValue
Returns Attr

Generated using TypeDoc