AstArenaNode

Object view of an arena node or token, returned by AstArena.toObject. The view does not copy the data: its properties are getters and setters that read and write the arena columns. A view only holds the arena and the node id (ARENAID).

the properties are the properties of the plain objects (PlainAstNode, PlainToken): typ, nam, sel, val, chi, tokens, unit, kin, l, r, op, ... and loc, state, errors, parent,
the nodes and tokens (children, value tokens, fields) are returned as new views in a frozen array. the arrays, the locations (loc) and the error lists (errors) cannot be modified (modifying them throws in strict mode): assign the property to modify the arena (node.chi = [...node.chi, rule]),
the values assigned can be node ids, views or plain objects. importing a view of the same arena is a noop: the node is used as is, the views of another arena are copied,
two views of the same node are different objects: compare their ARENAID,
JSON.stringify() and toJSON() return a deep plain copy (AstArena.toPlainObject).

function visitor(arena: AstArena, id: number) {

    const node = arena.toObject(id);

    if (node.nam == 'width') {

        node.nam = 'height';
        node.val = [{typ: EnumToken.LengthTokenType, val: 3, unit: 'px'}];
    }
}

Accessors

attr

get attr(): string | undefined
attribute of a match expression

Returns string | undefined
- Defined in src/lib/ast/arena-node.ts:413
set attr(attr: string | null | undefined): void
Parameters
- ```
attr: string | null | undefined
```
Returns void
- Defined in src/lib/ast/arena-node.ts:422

cal

get cal(): string | undefined
color space of a color

Returns string | undefined
- Defined in src/lib/ast/arena-node.ts:397
set cal(cal: string | null | undefined): void
Parameters
- ```
cal: string | null | undefined
```
Returns void
- Defined in src/lib/ast/arena-node.ts:406

chi

get chi(): readonly AstArenaNode[] | undefined
children: the child nodes of a stylesheet, a rule or an at-rule with a block, the tokens of a function token (arguments), a parentheses token, ... undefined when the node has no children

Returns readonly AstArenaNode[] | undefined
- Defined in src/lib/ast/arena-node.ts:315
set chi(chi: readonly AstArenaNodeInput[] | null | undefined): void
Parameters
- ```
chi: readonly AstArenaNodeInput[] | null | undefined
```
Returns void
- Defined in src/lib/ast/arena-node.ts:330

errors

get errors(): readonly ErrorDescription[] | null
validation errors. null when the node has no errors

Returns readonly ErrorDescription[] | null
- Defined in src/lib/ast/arena-node.ts:593
set errors(errors: readonly ErrorDescription[] | null | undefined): void
Parameters
- ```
errors: readonly ErrorDescription[] | null | undefined
```
Returns void
- Defined in src/lib/ast/arena-node.ts:600

kin

get kin(): ColorType | undefined
color type of a color token

Returns ColorType | undefined
- Defined in src/lib/ast/arena-node.ts:429
set kin(kin: ColorType | null | undefined): void
Parameters
- ```
kin: ColorType | null | undefined
```
Returns void
- Defined in src/lib/ast/arena-node.ts:438

l

get l(): AstArenaNode | readonly AstArenaNode[] | null | undefined
left hand side of a structured token, numerator of a fraction

Returns AstArenaNode | readonly AstArenaNode[] | null | undefined
- Defined in src/lib/ast/arena-node.ts:502
set l(l: AstArenaNodeInput | readonly AstArenaNodeInput[] | null): void
Parameters
- ```
l: AstArenaNodeInput | readonly AstArenaNodeInput[] | null
```
Returns void
- Defined in src/lib/ast/arena-node.ts:513

loc

get loc(): Readonly<SourceLocation> | null
source location. null when the node has no location

Returns Readonly<SourceLocation> | null
- Defined in src/lib/ast/arena-node.ts:568
set loc(loc: SourceLocation | null | undefined): void
Parameters
- ```
loc: SourceLocation | null | undefined
```
Returns void
- Defined in src/lib/ast/arena-node.ts:575

nam

get nam(): string | undefined
at-rule / declaration name, token name. undefined for the other nodes

Returns string | undefined
- Defined in src/lib/ast/arena-node.ts:185
set nam(nam: string): void
Parameters
- ```
nam: string
```
Returns void
- Defined in src/lib/ast/arena-node.ts:199

op

get op(): EnumToken | AstArenaNode | readonly AstArenaNode[] | null | undefined
operator: the operator of a binary expression, the operator tokens of a structured token

Returns EnumToken | AstArenaNode | readonly AstArenaNode[] | null | undefined
- Defined in src/lib/ast/arena-node.ts:459

Parameters

op: 
    | number
    | AstArenaNode
    | PlainAstNode
    | LiteralToken
    | IdentToken
    | IdentListToken
    | DashedIdentToken
    | WrappedValuesToken
    | CommaToken
    | ColonToken
    | DoubleColonToken
    | SemiColonToken
    | ClassSelectorToken
    | UniversalSelectorToken
    | ChildCombinatorToken
    | DescendantCombinatorToken
    | NextSiblingCombinatorToken
    | SubsequentCombinatorToken
    | ColumnCombinatorToken
    | NestingSelectorToken
    | WhenElseUnaryConditionToken
    | WhenElseQueryConditionToken
    | SupportsQueryUnaryConditionToken
    | SupportsQueryConditionToken
    | MediaQueryConditionToken
    | MediaFeatureToken
    | MediaQueryUnaryFeatureToken
    | IfConditionToken
    | IfElseConditionToken
    | NotToken
    | MediaFeatureOnlyToken
    | AndToken
    | OrToken
    | MediaRangeQueryToken
    | ContainerStyleRangeToken
    | DeclarationToken
    | NumberToken
    | AtRuleToken
    | PercentageToken
    | FlexToken
    | FunctionURLToken
    | FunctionImageToken
    | TimingFunctionToken
    | TimelineFunctionToken
    | FunctionToken
    | GridTemplateFuncToken
    | DimensionToken
    | LengthToken
    | AngleToken
    | StringToken
    | TimeToken
    | FrequencyToken
    | ResolutionToken
    | UnclosedStringToken
    | HashToken
    | BadStringToken
    | BlockStartToken
    | BlockEndToken
    | AttrStartToken
    | AttrEndToken
    | ParensStartToken
    | ParensEndToken
    | ParensToken
    | CDOCommentToken
    | BadCDOCommentToken
    | CommentToken
    | BadCommentToken
    | WhitespaceToken
    | IncludeMatchToken
    | StartMatchToken
    | EndMatchToken
    | ContainMatchToken
    | MatchExpressionToken
    | NameSpaceAttributeToken
    | ComposesSelectorToken
    | CssVariableToken
    | DashMatchToken
    | EqualMatchToken
    | LessThanToken
    | LessThanOrEqualToken
    | GreaterThanToken
    | GreaterThanOrEqualToken
    | ListToken
    | PseudoClassToken
    | PseudoPageToken
    | PseudoElementToken
    | PseudoClassFunctionToken
    | DelimToken
    | BinaryExpressionToken
    | UnaryExpression
    | FractionToken
    | AddToken
    | SubToken
    | DivToken
    | MulToken
    | BadUrlToken
    | UrlToken
    | ImportantToken
    | ColorToken
    | AttrToken
    | FunctionDefToken
    | RawNodeToken
    | NaNToken
    | InfinityToken
    | NegativeInfinityToken
    | CssTypeTokenType
    | EOFToken
    | readonly AstArenaNodeInput[]
    | null

Returns void

op1

get op1(): AstArenaNode | readonly AstArenaNode[] | null | undefined
first operator of a media range query

Returns AstArenaNode | readonly AstArenaNode[] | null | undefined
- Defined in src/lib/ast/arena-node.ts:480
set op1(op: AstArenaNodeInput | readonly AstArenaNodeInput[] | null): void
Parameters
- ```
op: AstArenaNodeInput | readonly AstArenaNodeInput[] | null
```
Returns void
- Defined in src/lib/ast/arena-node.ts:484

op2

get op2(): AstArenaNode | readonly AstArenaNode[] | null | undefined
second operator of a media range query

Returns AstArenaNode | readonly AstArenaNode[] | null | undefined
- Defined in src/lib/ast/arena-node.ts:491
set op2(op: AstArenaNodeInput | readonly AstArenaNodeInput[] | null): void
Parameters
- ```
op: AstArenaNodeInput | readonly AstArenaNodeInput[] | null
```
Returns void
- Defined in src/lib/ast/arena-node.ts:495

parent

get parent(): AstArenaNode | null
parent node, or the token that owns the token (see AstArena.getValueParent). null when the node is detached

Returns AstArenaNode | null
- Defined in src/lib/ast/arena-node.ts:608

r

get r(): AstArenaNode | readonly AstArenaNode[] | null | undefined
right hand side of a structured token, denominator of a fraction

Returns AstArenaNode | readonly AstArenaNode[] | null | undefined
- Defined in src/lib/ast/arena-node.ts:535
set r(r: AstArenaNodeInput | readonly AstArenaNodeInput[] | null): void
Parameters
- ```
r: AstArenaNodeInput | readonly AstArenaNodeInput[] | null
```
Returns void
- Defined in src/lib/ast/arena-node.ts:546

sel

get sel(): string | undefined
rule selector. undefined for the other nodes

Returns string | undefined
- Defined in src/lib/ast/arena-node.ts:206
set sel(sel: string): void
Parameters
- ```
sel: string
```
Returns void
- Defined in src/lib/ast/arena-node.ts:216

sign

get sign(): EnumToken | undefined
sign of a unary expression

Returns EnumToken | undefined
- Defined in src/lib/ast/arena-node.ts:445
set sign(sign: EnumToken): void
Parameters
- ```
sign: EnumToken
```
Returns void
- Defined in src/lib/ast/arena-node.ts:452

state

get state(): EnumAstNodeStatus
validation state

Returns EnumAstNodeStatus
- Defined in src/lib/ast/arena-node.ts:582
set state(state: EnumAstNodeStatus | null | undefined): void
Parameters
- ```
state: EnumAstNodeStatus | null | undefined
```
Returns void
- Defined in src/lib/ast/arena-node.ts:586

tokens

get tokens(): readonly AstArenaNode[] | null
prelude tokens of an at-rule, selector tokens of a rule. null when the node has no prelude tokens

Returns readonly AstArenaNode[] | null
- Defined in src/lib/ast/arena-node.ts:364
set tokens(tokens: readonly AstArenaNodeInput[] | null | undefined): void
Parameters
- ```
tokens: readonly AstArenaNodeInput[] | null | undefined
```
Returns void
- Defined in src/lib/ast/arena-node.ts:373

typ

get typ(): EnumToken
node or token type

Returns EnumToken
- Defined in src/lib/ast/arena-node.ts:174
set typ(typ: EnumToken): void
Parameters
- ```
typ: EnumToken
```
Returns void
- Defined in src/lib/ast/arena-node.ts:178

unit

get unit(): string | undefined
unit of a dimension, calendar (cal) of a color, attribute (attr) of a match expression

Returns string | undefined
- Defined in src/lib/ast/arena-node.ts:380
set unit(unit: string | null | undefined): void
Parameters
- ```
unit: string | null | undefined
```
Returns void
- Defined in src/lib/ast/arena-node.ts:390

val

get val(): | string
| number
| AstArenaNode
| readonly AstArenaNode[]
| null
| undefined
value:
- at-rule prelude, comment: string,
- declaration: value tokens,
- number, dimension, percentage: number (or the fraction token),
- identifier, string, function name, ...: string,
- unary expression: the operand,
- structured tokens with a value field: the field tokens
Returns string | number | AstArenaNode | readonly AstArenaNode[] | null | undefined
- Defined in src/lib/ast/arena-node.ts:229
set val(
    val:
        | string
        | AstArenaNodeInput
        | readonly AstArenaNodeInput[]
        | null
        | undefined,
): void
Parameters
- ```
val: string | AstArenaNodeInput | readonly AstArenaNodeInput[] | null | undefined
```
Returns void
- Defined in src/lib/ast/arena-node.ts:271

Constructors

constructor

new AstArenaNode(arena: AstArena, id: number): AstArenaNode

Parameters

```
arena: AstArena
```
```
id: number
```

Returns AstArenaNode

Methods

toJSON

toJSON(): PlainAstNode | PlainToken

deep plain copy of the node, see AstArena.toPlainObject

Returns PlainAstNode | PlainToken

Properties

`Readonly`[ARENA]

"[ARENA]": AstArena

arena of the node

`Readonly`[ARENAID]

"[ARENAID]": number

node id in the arena

AstArenaNode

Index

Accessors

Constructors

Methods

Properties

Accessors

attr

Returns string | undefined

Parameters

Returns void

cal

Returns string | undefined

Parameters

Returns void

chi

Returns readonly AstArenaNode[] | undefined

Parameters

Returns void

errors

Returns readonly ErrorDescription[] | null

Parameters

Returns void

kin

Returns ColorType | undefined

Parameters

Returns void

l

Returns AstArenaNode | readonly AstArenaNode[] | null | undefined

Parameters

Returns void

loc

Returns Readonly<SourceLocation> | null

Parameters

Returns void

nam

Returns string | undefined

Parameters

Returns void

op

Returns EnumToken | AstArenaNode | readonly AstArenaNode[] | null | undefined

Parameters

Returns void

op1

Returns AstArenaNode | readonly AstArenaNode[] | null | undefined

Parameters

Returns void

op2

Returns AstArenaNode | readonly AstArenaNode[] | null | undefined

Parameters

Returns void

parent

Returns AstArenaNode | null

r

Returns AstArenaNode | readonly AstArenaNode[] | null | undefined

Parameters

Returns void

sel

Returns string | undefined

Parameters

Returns void

sign

Returns EnumToken | undefined

Parameters

Returns void

state

Returns EnumAstNodeStatus

Parameters

Returns void

tokens

Returns readonly AstArenaNode[] | null

Parameters

Returns void

typ

Returns EnumToken

Parameters

Returns void

unit

Returns string | undefined

Parameters

`Readonly`[ARENA]

`Readonly`[ARENAID]