pacc 1.0.0 → 1.0.1

package/README.md

@@ -15,6 +15,82 @@ propetty path utils
 
 # API
 
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+*   [AttributeDefinition](#attributedefinition)
+    *   [Properties](#properties)
+*   [tokens](#tokens)
+    *   [Parameters](#parameters)
+*   [setAttribute](#setattribute)
+    *   [Parameters](#parameters-1)
+*   [getAttribute](#getattribute)
+    *   [Parameters](#parameters-2)
+*   [getAttributeAndOperator](#getattributeandoperator)
+    *   [Parameters](#parameters-3)
+
+## AttributeDefinition
+
+Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
+### Properties
+
+*   `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
+*   `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should the value be shown
+*   `depends` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of an attribute we depend on
+*   `additionalAttributes` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** extra attributes that are present in case our attribute is set
+*   `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `default` **any?** the default value
+*   `set` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** set the value
+*   `get` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** get the value can be used to calculate default values
+*   `env` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))?** environment variable use to provide the value
+
+## tokens
+
+Split property path into tokens
+
+### Parameters
+
+*   `string` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+
+## setAttribute
+
+Set Object attribute.
+The name may be a property path like 'a.b.c'.
+
+### Parameters
+
+*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
+*   `expression` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `value` **any**&#x20;
+
+## getAttribute
+
+Deliver attribute value.
+The name may be a property path like 'a.b.c' or a\[2]
+
+### Parameters
+
+*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
+*   `expression` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+
+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](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
+*   `expression` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `getters`   (optional, default `{}`)
+
+Returns **\[any, [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)]** value associated with the given property name
+
 # install
 
 With [npm](http://npmjs.org) do:

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "pacc",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "publishConfig": {
     "access": "public"
   },
+  "exports": {
+    ".": "./src/attribute.mjs"
+  },
   "description": "property path utils",
   "contributors": [
     {
@@ -11,9 +14,6 @@
       "email": "markus.felten@gmx.de"
     }
   ],
-  "exports": {
-    ".": "./src/attribute.mjs"
-  },
   "license": "BSD-2-Clause",
   "scripts": {
     "test": "npm run test:browser-ava && npm run test:ava",

package/src/attribute.mjs

@@ -27,11 +27,11 @@ export function* tokens(string) {
       case "string-escaping":
         const esc = {
           "\\": "\\",
-          t: "\t",
           b: "\b",
-          r: "\r",
+          f: "\f",
           n: "\n",
-          f: "\f"
+          r: "\r",
+          t: "\t"
         };
         buffer += esc[c];
         state = "string";
@@ -233,6 +233,10 @@ export function setAttribute(object, expression, value) {
  * @returns {any} value associated with the given property name
  */
 export function getAttribute(object, expression) {
+  if (object?.[expression] !== undefined) {
+    return object[expression];
+  }
+
   return getAttributeAndOperator(object, expression)[0];
 }