Class ArrayPattern

Pattern for matching array values in envelope leaf nodes.

Corresponds to the Rust ArrayPattern struct in array_pattern.rs

Implements

Matcher

Index

Accessors

Methods

any count interval fromDcborPattern withPatterns pathsWithCaptures paths matches compile isComplex toString equals hashCode

Accessors

pattern

get pattern(): ArrayPatternType
Gets the pattern type.

Returns ArrayPatternType
- Defined in envelope-pattern/src/pattern/leaf/array-pattern.ts:95

Methods

`Static`any

any(): ArrayPattern
Creates a new ArrayPattern that matches any array.

Returns ArrayPattern
- Defined in envelope-pattern/src/pattern/leaf/array-pattern.ts:56

`Static`count

count(count: number): ArrayPattern
Creates a new ArrayPattern that matches arrays with a specific length.
Parameters
- count: number
Returns ArrayPattern
- Defined in envelope-pattern/src/pattern/leaf/array-pattern.ts:63

`Static`interval

interval(min: number, max?: number): ArrayPattern
Creates a new ArrayPattern that matches arrays within a length range.
Parameters
- min: number
- Optionalmax: number
Returns ArrayPattern
- Defined in envelope-pattern/src/pattern/leaf/array-pattern.ts:73

`Static`fromDcborPattern

fromDcborPattern(dcborPattern: Pattern): ArrayPattern
Creates a new ArrayPattern from a dcbor-pattern.
Parameters
- dcborPattern: Pattern
Returns ArrayPattern
- Defined in envelope-pattern/src/pattern/leaf/array-pattern.ts:81

`Static`withPatterns

withPatterns(patterns: Pattern[]): ArrayPattern
Creates a new ArrayPattern with envelope patterns for element matching.
Parameters
- patterns: Pattern[]
Returns ArrayPattern
- Defined in envelope-pattern/src/pattern/leaf/array-pattern.ts:88

pathsWithCaptures

pathsWithCaptures(haystack: Envelope): [Path[], Map<string, Path[]>]
Return all matching paths along with any named captures.
Parameters
- haystack: Envelope
Returns [Path[], Map<string, Path[]>]
Implementation of Matcher.pathsWithCaptures
- Defined in envelope-pattern/src/pattern/leaf/array-pattern.ts:99

paths

paths(haystack: Envelope): Path[]
Return only the matching paths, discarding any captures.
Parameters
- haystack: Envelope
Returns Path[]
Implementation of Matcher.paths
- Defined in envelope-pattern/src/pattern/leaf/array-pattern.ts:177

matches

matches(haystack: Envelope): boolean
Returns true if the pattern matches the haystack.
Parameters
- haystack: Envelope
Returns boolean
Implementation of Matcher.matches
- Defined in envelope-pattern/src/pattern/leaf/array-pattern.ts:181

compile

compile(code: Instr[], literals: Pattern[], captures: string[]): void
Compile this pattern to bytecode.
Parameters
- code: Instr[]
- literals: Pattern[]
- captures: string[]
Returns void
Implementation of Matcher.compile
- Defined in envelope-pattern/src/pattern/leaf/array-pattern.ts:185

isComplex

isComplex(): boolean
Returns true if the Display of the matcher is complex, i.e. contains nested patterns or other complex structures that require its text rendering to be surrounded by grouping parentheses.

Returns boolean
Implementation of Matcher.isComplex
- Defined in envelope-pattern/src/pattern/leaf/array-pattern.ts:192

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in envelope-pattern/src/pattern/leaf/array-pattern.ts:196

equals

equals(other: ArrayPattern): boolean
Equality comparison.
Parameters
- other: ArrayPattern
Returns boolean
- Defined in envelope-pattern/src/pattern/leaf/array-pattern.ts:212

hashCode

hashCode(): number
Hash code for use in Maps/Sets.

Returns number
- Defined in envelope-pattern/src/pattern/leaf/array-pattern.ts:246