pacc

propetty path utils

import { getAttribute, expand } from "pacc";

const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
// result === 4

const result = expand("${a + 1}",{ current: { a: 2 }});
// result === 3

Benchmark

benchmark avg (min … max) p75 / p99 (min … top 1%)

---

"[n<5].l" 1.17 µs/iter 1.67 µs █ (833.64 ns … 2.47 µs) 2.42 µs █ (281.78 b … 3.28 kb) 3.01 kb █▇▂▁▃▂▁▁▁▁▁▃▂▄▄▂▂▁▁▂▁ 4.72 ipc ( 2.55% stalls) 98.55% L1 data cache 3.75k cycles 17.68k instructions 39.84% retired LD/ST ( 7.04k)

parse a.b.c.d.e.f.g.h.i.j.k.l.m.n 2.96 µs/iter 3.25 µs ▂█▂ ▅ (2.60 µs … 3.44 µs) 3.41 µs ███▅▅ ▅█▂▂▂▂ ( 6.10 kb … 6.11 kb) 6.10 kb █████▄▁▁▁▁▁▁▄▄▁██████ 5.09 ipc ( 2.02% stalls) 99.10% L1 data cache 9.40k cycles 47.87k instructions 40.50% retired LD/ST ( 19.38k)

parseOnly a.b.c.d.e.f.g.h.i.j.k.l.m.n 2.51 µs/iter 2.85 µs █ (2.18 µs … 3.36 µs) 3.35 µs █▆ ( 4.54 kb … 5.43 kb) 5.41 kb ██▄▄▂▁▁▁▁▃▂█▇█▂▁▂▁▂▁▂ 5.12 ipc ( 2.18% stalls) 98.98% L1 data cache 8.05k cycles 41.20k instructions 40.73% retired LD/ST ( 16.78k)

tokens a.b.c.d.e.f.g.h.i.j.k.l.m.n 1.66 µs/iter 1.68 µs ▆ █▄ ▃ (1.61 µs … 1.75 µs) 1.74 µs ▅█▄██▄ █▂ ▂▅ ( 4.41 kb … 4.42 kb) 4.41 kb ██████▅▁██▃▅▃▆▆██▃▃▁▆ 5.67 ipc ( 2.53% stalls) 99.12% L1 data cache 5.32k cycles 30.18k instructions 40.68% retired LD/ST ( 12.27k)

tokens "abc" " " "abcdefghijklmnopqrstuvwxyz" 1.23 µs/iter 1.12 µs █ (1.02 µs … 2.23 µs) 1.85 µs █▆ ( 2.52 kb … 4.17 kb) 3.43 kb ███▁▁▁▁▁▁▁▁▁▁▁▁▁▂▂▇▄▃ 6.02 ipc ( 2.26% stalls) 99.24% L1 data cache 3.94k cycles 23.72k instructions 39.67% retired LD/ST ( 9.41k)

API

Table of Contents

• AST
  • Properties
• prepareAttributesDefinitions
  • Parameters
• mergeAttributeDefinitions
  • Parameters
• attributeIterator
  • Parameters
• extendingAttributeIterator
  • Parameters
• parseBytes
  • Parameters
• AttributeDefinition
  • Properties
• default_attribute
• default_attribute_writable
• default_collection_attribute
• default_collection_attribute_writable
• string_attribute
• string_attribute_writable
• string_collection_attribute
• string_collection_attribute_writable
• string_set_attribute
• string_set_attribute_writable
• name_attribute
• name_attribute_writable
• email_attribute
• version_attribute
• version_attribute_writable
• description_attribute
• type_attribute
• type_attribute_writable
• state_attribute_writable
• boolean_attribute
• boolean_attribute_writable
• boolean_attribute_writable_true
• boolean_attribute_writable_true
• boolean_attribute_writable_false
• boolean_attribute_false
• yesno_attribute
• empty_attribute
• uuid_attribute
• secret_attribute
• secret_attribute
• secret_attribute_writable
• username_attribute
• password_attribute
• token_attribute
• private_key_attribute
• public_key_attribute
• number_attribute
• number_attribute_writable
• integer_attribute
• integer_attribute
• integer_attribute_writable
• integer_attribute_writable
• size_attribute
• object_attribute
• url_attribute
• url_attribute_writable
• hostname_attribute
• port_attribute
• port_attribute_writable
• id_attribute
• body_attribute_writable
• title_attribute_writable
• priority_attribute
• priority_attribute
• duration_attribute
• duration_attribute_writable
• duration_ms_attribute
• timeout_attribute
• language_attribute
• environmentValues
  • Parameters
• expandContextDefault
• expandContextDoubbleCurly
• expand
  • Parameters
• promises
• filter
  • Parameters
• setAttributes
  • Parameters
• getAttributes
  • Parameters
• getAttributesJSON
  • Parameters
• tokens
• tokens
  • Parameters
• setAttribute
  • Parameters
• getAttribute
  • Parameters
• getAttributeAndOperator
  • Parameters
• parseDuration
  • Parameters
• formatDuration
  • Parameters
• formatDurationISO
  • Parameters
• lookup
• Token
  • Properties
• registerToken
  • Parameters
• createToken
  • Parameters
• PLUS
• MINUS
• STAR
• DIVIDE
• NOT
• NOT_EQUAL
• EQUAL
• GREATER
• GREATER_EQUAL
• LESS
• LESS_EQUAL
• OPEN_ROUND
• CLOSE_ROUND
• OPEN_BRACKET
• CLOSE_BRACKET
• OPEN_CURLY
• CLOSE_CURLY
• QUESTION
• COLON
• SEMICOLON
• COMMA
• DOT
• AMPERSAND
• DOUBLE_AMPERSAND
• BAR
• DOUBLE_BAR
• IDENTIFIER
• STRING
• NUMBER
• BOOLEAN
• EOF
• Type
  • Properties
• raiseOnUnknownType
  • Parameters

AST

Type: Object

Properties

• eval Function?

prepareAttributesDefinitions

Create attributes from its definition.

Parameters

• newDefinitions Object
• presentDefinitions Object? optional merge in attributes

Returns Object attributes

mergeAttributeDefinitions

Merge attribute definitions.

Parameters

• dest Object attribute definitions to be used also the merge target
• atts Object? attribute definitions to be used

Returns Object merged definitions (dest)

attributeIterator

Iterate over attributes.

Parameters

• definition
• filter Function?
• path Array<string>? (optional, default [])
• attribute Object definition

Returns Iterable<[Array<string>, object]>

extendingAttributeIterator

Iterate over all attributes of a type.

Parameters

• type Type definition
• filter Function?
• path Array<string>?

Returns Iterable<[Array<string>, object]>

parseBytes

Convert byte size formatted string into number of bytes.

Parameters

• value (number | string)

Returns number number of total bytes

AttributeDefinition

Type: Object

Properties

• name string
• type Type
• key boolean are we an identifying attribute
• writable boolean can this attribute be modified
• mandatory boolean
• collection boolean are we a collection (set, map, array, object)
• private boolean? should the value be shown
• credential boolean? any type of credential
• persistent boolean? should we be stored (especially critical for credentials)
• backpointer AttributeDefinition?
• constructor Function? (collection) constructor
• depends string? name of an attribute we depend on
• description string? human readable
• default any? the default value
• set Function? set the value
• get Function? get the value can be used to calculate default values
• toInternal Function?
• toExternal Function?
• asMapEntry Function? deliver key and value for Map insertion
• externalName string? attribute name used by external system
• values Set<any>? allowed values
• env (Array<string> | string)? environment variable(s) used to provide the value
• additionalValues object? other values to be set in case our attribute is set
• separator string? separator for collections

default_attribute

Common attribute properties.

Type: AttributeDefinition

default_attribute_writable

Type: AttributeDefinition

default_collection_attribute

Type: AttributeDefinition

default_collection_attribute_writable

Type: AttributeDefinition

string_attribute

Type: AttributeDefinition

string_attribute_writable

Type: AttributeDefinition

string_collection_attribute

Type: AttributeDefinition

string_collection_attribute_writable

Type: AttributeDefinition

string_set_attribute

Type: AttributeDefinition

string_set_attribute_writable

Type: AttributeDefinition

name_attribute

Type: AttributeDefinition

name_attribute_writable

Type: AttributeDefinition

email_attribute

Type: AttributeDefinition

version_attribute

Type: AttributeDefinition

version_attribute_writable

Type: AttributeDefinition

description_attribute

The description of the object content.

Type: AttributeDefinition

type_attribute

Type: AttributeDefinition

type_attribute_writable

Type: AttributeDefinition

state_attribute_writable

Type: AttributeDefinition

boolean_attribute

Type: AttributeDefinition

boolean_attribute_writable

Type: AttributeDefinition

boolean_attribute_writable_true

Type: AttributeDefinition

boolean_attribute_writable_true

Type: AttributeDefinition

boolean_attribute_writable_false

Type: AttributeDefinition

boolean_attribute_false

Type: AttributeDefinition

yesno_attribute

Type: AttributeDefinition

empty_attribute

Type: AttributeDefinition

uuid_attribute

Type: AttributeDefinition

secret_attribute

Type: AttributeDefinition

secret_attribute

Type: AttributeDefinition

secret_attribute_writable

Type: AttributeDefinition

username_attribute

Type: AttributeDefinition

password_attribute

Type: AttributeDefinition

token_attribute

Type: AttributeDefinition

private_key_attribute

Type: AttributeDefinition

public_key_attribute

Type: AttributeDefinition

number_attribute

Type: AttributeDefinition

number_attribute_writable

Type: AttributeDefinition

integer_attribute

Type: AttributeDefinition

integer_attribute

Type: AttributeDefinition

integer_attribute_writable

Type: AttributeDefinition

integer_attribute_writable

Type: AttributeDefinition

size_attribute

Type: AttributeDefinition

object_attribute

Type: AttributeDefinition

url_attribute

Type: AttributeDefinition

url_attribute_writable

Type: AttributeDefinition

hostname_attribute

Type: AttributeDefinition

port_attribute

Type: AttributeDefinition

port_attribute_writable

Type: AttributeDefinition

id_attribute

Unique id within.

Type: AttributeDefinition

body_attribute_writable

The body text.

Type: AttributeDefinition

title_attribute_writable

The one line description.

Type: AttributeDefinition

priority_attribute

In case there are several providers able to support a given source which one sould be used ? this defines the order.

Type: AttributeDefinition

priority_attribute

Type: AttributeDefinition

duration_attribute

Duration in seconds.

Type: AttributeDefinition

duration_attribute_writable

Type: AttributeDefinition

duration_ms_attribute

Type: AttributeDefinition

timeout_attribute

Type: AttributeDefinition

language_attribute

Type: AttributeDefinition

environmentValues

Extract values from environment.

Parameters

• env Object as from process.env
• attributes Object as from process.env
• instanceIdentifier string part of variable name.

Returns (Object | undefined) undefined if no suitable environment variables have been found

expandContextDefault

Default expand context using '§{' and '}' as lead in/out

expandContextDoubbleCurly

Expand context with doubble curly separaion '{{' '}}'

expand

Expand expressions inside of object graphs.

Parameters

• object any

• context Object

  • context.root any? actual replacement values
  • context.current any? actual replacement values
  • context.stopClass function? do not expand instancif
  • context.leadIn string? starting separator
  • context.leadOut string? ending separator

Returns (any | Promise<any>)

promises

Type: Array<Promise<any>>

filter

Generate filter function.

Parameters

• filterBy Object?

Returns Function

setAttributes

Copies attribute values from a source object into a destination object.

Parameters

• object Object target object to be modified
• source Object origin of the data to be copied
• definitions Object attribute definitions to be used
• cb function? callback to be executed for each copied value

getAttributes

Retrive attribute values from an object.

Parameters

• object Object attribute value source
• definitions Object
• filter Function?

Returns Object values

getAttributesJSON

Retrive attribute values from an object.

Parameters

• object Object attribute value source
• definitions Object
• filter Function?

Returns Object values

tokens

tokens

Split expression path into tokens.

Parameters

• string string
• context Object

setAttribute

Set object attribute. The name may be a property path like 'a.b.c'.

Parameters

• object Object
• expression string
• value any
• definition Object? type def

getAttribute

Deliver attribute value. The name may be a property path like 'a.b.c' or a[2]

Parameters

• object Object
• expression string
• definition Object?

Returns any value associated with the given property name

getAttributeAndOperator

Deliver attribute value and operator. The name may be a property path like 'a.b.c <='.

Parameters

• object Object
• expression string

Returns [any, Token] value associated with the given property name

parseDuration

Convert duration formatted string into number of seconds.

Parameters

• value (number | string)

Returns number seconds

formatDuration

Parameters

• seconds number

Returns string formatted duration

formatDurationISO

Parameters

• seconds number

Returns string formatted duration

lookup

Token lookup

Token

Type: Object

Properties

• str string
• precedence number
• led Function
• nud Function

registerToken

Parameters

• token Token

createToken

Parameters

• str string
• precedence number? (optional, default 0)
• type string?
• led Function? (optional, default (parser,node)=>node)
• nud (optional, default parser=>this)

Returns Token

PLUS

Type: Token

MINUS

Type: Token

STAR

Type: Token

DIVIDE

Type: Token

NOT

Type: Token

NOT_EQUAL

Type: Token

EQUAL

Type: Token

GREATER

Type: Token

GREATER_EQUAL

Type: Token

LESS

Type: Token

LESS_EQUAL

Type: Token

OPEN_ROUND

Type: Token

CLOSE_ROUND

Type: Token

OPEN_BRACKET

Type: Token

CLOSE_BRACKET

Type: Token

OPEN_CURLY

Type: Token

CLOSE_CURLY

Type: Token

QUESTION

Type: Token

COLON

Type: Token

SEMICOLON

Type: Token

COMMA

Type: Token

DOT

Type: Token

AMPERSAND

Type: Token

DOUBLE_AMPERSAND

Type: Token

BAR

Type: Token

DOUBLE_BAR

Type: Token

IDENTIFIER

Type: Token

STRING

Type: Token

NUMBER

Type: Token

BOOLEAN

Type: Token

EOF

Type: Token

Type

Type: Object

Properties

• name string
• primitive boolean?
• extends Type?
• members Set<Type>?
• clazz Function?
• toInternal Function?
• toExternal Function?

raiseOnUnknownType

Throw if type is not known.

Parameters

• type (Type | string | undefined)
• origin any

Returns Type

install

With npm do:

npm install pacc

license

BSD-2-Clause