pacc

propetty path utils

import { getAttribute } from "pacc";

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

API

Table of Contents

• prepareAttributesDefinitions
  • Parameters
• mergeAttributeDefinitions
  • Parameters
• attributeIterator
  • Parameters
• parseBytes
  • Parameters
• AttributeDefinition
  • Properties
• default_attribute
• default_attribute
• default_attribute
• default_attribute_writable
• default_attribute_writable
• default_attribute_writable
• default_attribute_writable
• string_collection_attribute_writable
• name_attribute
• name_attribute_writable
• email_attribute
• version_attribute
• version_attribute_writable
• description_attribute
• boolean_attribute
• boolean_attribute_writable
• boolean_attribute_writable_true
• boolean_attribute_writable_true
• boolean_attribute_writable_false
• boolean_attribute_false
• empty_attribute
• uuid_attribute
• secret_attribute
• secret_attribute
• secret_attribute
• secret_attribute
• secret_attribute
• private_key_attribute
• public_key_attribute
• number_attribute
• number_attribute_writable
• integer_attribute
• integer_attribute
• integer_attribute
• integer_attribute_writable
• integer_attribute_writable
• object_attribute
• url_attribute
• url_attribute_writable
• hostname_attribute
• port_attribute
• id_attribute
• title_attribute_writable
• priority_attribute
• duration_attribute
• duration_ms_attribute
• timeout_attribute
• language_attribute
• environmentValues
  • Parameters
• expand
  • Parameters
• 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
• 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
• EOF
• Type
  • Properties

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 all attributes.

Parameters

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

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

• type object
• isKey boolean
• writable boolean
• mandatory boolean
• collection boolean
• private boolean? should the value be shown
• credential boolean? any type of credential
• persistent boolean? should we be stored
• 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
• prepareValue Function?
• values Set<any>? allowed values
• externalName string? attrubute name used by external system
• 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

default_attribute

Common attribute properties.

Type: AttributeDefinition

default_attribute

Type: AttributeDefinition

default_attribute

Type: AttributeDefinition

default_attribute_writable

Type: AttributeDefinition

default_attribute_writable

Type: AttributeDefinition

default_attribute_writable

Type: AttributeDefinition

default_attribute_writable

The body text.

Type: AttributeDefinition

string_collection_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

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

empty_attribute

Type: AttributeDefinition

uuid_attribute

Type: AttributeDefinition

secret_attribute

Type: AttributeDefinition

secret_attribute

Type: AttributeDefinition

secret_attribute

Type: AttributeDefinition

secret_attribute

Type: AttributeDefinition

secret_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

Type: AttributeDefinition

integer_attribute_writable

Type: AttributeDefinition

integer_attribute_writable

Type: AttributeDefinition

object_attribute

Type: AttributeDefinition

url_attribute

Type: AttributeDefinition

url_attribute_writable

Type: AttributeDefinition

hostname_attribute

Type: AttributeDefinition

port_attribute

Type: AttributeDefinition

id_attribute

Unique id within.

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

duration_attribute

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

expand

Expand expressions inside of object graphs.

Parameters

• object any

• context Object (optional, default {})

  • context.root any
  • context.stopClass function?
  • context.leadIn string?
  • context.leadOut string?

Returns 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

Returns Object values

getAttributesJSON

Retrive attribute values from an object.

Parameters

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

Returns Object values

tokens

tokens

Split property path into tokens

Parameters

• string string

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

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

createToken

Parameters

• str string
• precedence (optional, default 0)
• type

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

EOF

Type: Token

Type

Type: Object

Properties

• name string
• primitive boolean?
• prepareValue Function?

install

With npm do:

npm install pacc

license

BSD-2-Clause