Merge branch 'develop' into main

Author: JonRC

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+teste.ts

.npmignore

@@ -0,0 +1,3 @@
+node_modules/
+teste.ts
+src/

LICENSE.md

@@ -1 +1,149 @@
-getinto
+# getinto
+
+getinto is a simple package to deep get something in an object. 
+It always return a value (array, function, string, object...) or undefined. Never a error (if you use the correct sintax).
+Say bye for error "Cannot read property of undefined"
+  - Simple sintax
+  - TypeScript compatibility  
+  - Can be use with object chain and function chain mixed
+      
+
+### Quick Example
+```js
+const into = require('getinto')
+const animals = {
+    pets: [
+        {
+            name: 'Rex',
+            owner: {
+                name: 'Jon',
+                address: {
+                    country: 'USA',
+                    province: 'British Columbia'
+                }
+            }
+        }
+    ]
+}
+
+const province = into(animals)
+    .into('pets')
+    .into('1')
+    .into('owner')
+    .into('adress')
+    .get('province') //get return a array, function, string, object... or undefined. Never a error.
+console.log(province) //log: 'British Columbia'
+
+const errorPetName = animals.notExist.name //errror: Cannot read property 'name' of undefined
+const petName = into(animals)
+    .into('notExist')
+    .get('name') 
+console.log(petName) //log: undefined
+```
+
+### Installation
+```sh
+$ npm install getinto
+or
+$ yarn add getinto
+```
+
+### Usage
+I suggest the following way to import
+```js
+const into = require('getinto')
+```
+You can write a chan of 'into'. The first into comes from import and receive an object (or a function, see in 'More examples' or in 'API' for details). The next intos come from previous into. The latter statement must be 'get'.
+```js
+const into = require('getinto')
+const value = into(object)
+  .into('objectPropertie')
+  .into('nextObjectPropertie')
+  ...
+  ...
+  .into('otherPropertie')
+  .get('returnedPropertie')
+console.log(value) //log: returnedPropertie
+```
+### Typescript Usage
+Writing
+
+### API
+writing the compleate API documentation
+
+### More Examples
+```js
+const into = require('getinto')
+const business = {
+ stories: [
+  {
+    companyName: 'megaPet, INC',
+    products: ['dogFood', 'dogBed'],
+    stack: ['react', 'node.js', 'mongoDB'],
+    doSomething: function (name) {console.log(name + ' says Hello World')}
+  },
+  {
+    companyName: function (baseName) { return baseName + ', INC' },
+    products: function (a, b) { return [a + 'Product', b + 'Product']},
+    doSomething: function () {console.log('Hello World')}
+  }
+ ]
+}
+   
+business[0].stories.notExist.techs[0] //error: Cannot read property 'techs' of undefined
+into(business)
+  .into('0')
+  .into('notExist')
+  .into('techs')
+  .get('0') //undefined
+   
+into(business)
+  .into('stories')
+  .into('0')
+  .get('companyName') // 'megaPet, INC' - if something don't exist return undefined
+
+into(business)
+  .into('stories')
+  .into('0')
+  .get('products') // ['dogFood', 'dogBed'] - if something don't exist return undefined
+  
+into(business)
+  .into('stories')
+  .into('0')
+  .into('stack')
+  .get('1') // 'node.js' - if something don't exist return undefined
+  
+const functionExample = into(business)
+  .into('stories')
+  .into('0')
+  .get('doSomething')
+  functionExample('Jonathan') //log: 'Jonathan says Hello World' - if something don't exist return undefined
+  
+into(business)
+  .into('stories')
+  .into('1')
+  .get('companyName', 'superMarket') // 'superMarket, INC' - executed like companyName('superMarket')
+
+const productA = 'fishmonger'  
+into(business)
+  .into('stories')
+  .into('1')
+  .get('products', [productA, 'bakery']) // ['fishmongerProducts', 'bakeryProducts'] - executed like products(productA, 'bakery')
+  
+into(business)
+  .into('stories')
+  .into('1')
+  .get('doSomething', []) //log: 'Hello World - executed like doSomething()
+}
+```
+
+### array example
+Writing
+### object example
+Writing
+### function example
+Writing
+
+### Todos
+Writing
+

README.md

@@ -0,0 +1,10 @@
+interface getintoObject {
+    into(key: string, params?: string | string[]): getintoObject;
+    get<T>(key: string, params?: string | string[], callback?: (gotten: T) => any): T;
+}
+interface ObjectOrFunction {
+    [key: string]: Object | Function | Array<any>;
+}
+declare function intoInitiator(anyType: ObjectOrFunction, params?: string | string[], thisArg?: object): getintoObject;
+export default intoInitiator;
+//# sourceMappingURL=index.d.ts.map

lib/index.d.ts

@@ -0,0 +1,38 @@
+{
+  "name": "getinto",
+  "version": "1.0.0",
+  "description": "A simple JS package to access a value in a object",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "author": "Jonathan R C <jonarc06@gmail.com>",
+  "license": "MIT",
+  "scripts": {
+    "dev": "ts-node-dev --respawn --transpile-only src/index.ts",
+    "build": "tsc"
+  },
+  "devDependencies": {
+    "ts-node-dev": "^1.1.1",
+    "typescript": "^4.1.3"
+  },
+  "dependencies": {},
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/JonRC/getinto.git"
+  },
+  "keywords": [
+    "deep",
+    "get",
+    "propertie",
+    "properties",
+    "function",
+    "array",
+    "in",
+    "into",
+    "object",
+    "objects"
+  ],
+  "bugs": {
+    "url": "https://github.com/JonRC/getinto/issues"
+  },
+  "homepage": "https://github.com/JonRC/getinto"
+}

lib/index.d.ts.map

@@ -0,0 +1,72 @@
+
+interface getintoObject {
+  into(key: string, params?: string | string[]): getintoObject
+  get<T>(key: string, params?: string | string[], callback?: (gotten: T) => any): T
+  
+}
+
+interface ObjectOrFunction {
+  [key: string]: Object | Function | Array<any>;
+}
+
+function intoInitiator(anyType: ObjectOrFunction, params?: string | string[], thisArg?: object): getintoObject {
+  anyType = functionVerifier(anyType, params, thisArg)
+  return intoContructor(anyType)
+}
+
+function intoContructor(anyType: ObjectOrFunction): getintoObject {
+  function getInto(anyType: ObjectOrFunction, key: string, params?: string | string[]) {
+    if (anyType) {
+      if (anyType instanceof Array) {
+        key = key.replace('[', '').replace(']', '')
+        const value = anyType[key]
+        return functionVerifier(value, params, anyType)
+      }
+      else if (anyType instanceof Object) {
+        const value = anyType[key]
+        return functionVerifier(value, params, anyType)
+      }
+      else {
+        return undefined
+      }
+    }
+    else {
+      return undefined
+    }
+  }
+
+  
+  return {
+    into: (key, params) => {
+      return intoContructor(getInto(anyType, key, params))
+    },
+
+    get: (key, params, callback?) => {
+      const value = getInto(anyType, key, params)
+      if(callback instanceof Function) callback(value)
+      return value
+    },
+
+  }
+}
+
+function functionVerifier(anyValue: Object | Function, params?: string | string[], thisArg?: any) {
+  if (anyValue instanceof Function && params) {
+    if (params instanceof Array) {
+      return anyValue.bind(thisArg)(...params)
+    }
+    else {
+      return anyValue.bind(thisArg)(params)
+    }
+  }
+
+  else if(anyValue instanceof Function){
+    return anyValue.bind(thisArg)
+  }
+
+  else {
+    return anyValue
+  }
+}
+
+export default intoInitiator