\n```\n\nused to create an async pipeline to a value. It's an async version of the createPipe function, but it works with promises.\nEach function in the pipeline should receive the value passed from the previous function, which is mapped by the other functions in the pipeline.\n\nThis transformation occurs from left to right.\n\n**operations**: one or more callback functions to transform the value in the pipeline.\n\n**value**: value to be transformed in the pipeline\n\n```js\nimport { createAsyncPipe, log } from '@cahmoraes93/utils'\n\nconst double = (n1) => Promise.resolve(n1 * 2)\nconst triple = (n1) => Promise.resolve(n1 * 3)\n\nconst transformValue = createAsyncPipe(double, triple)\nconst result = await transformValue(Promise.resolve(3))\n\nlog(result)\n//=> 18\n```\n\n
\n\n# typeOf\n\n```ts\n- typeOf(element: any): string\n```\n\nused to check the data type of a given element.\nThis function recognizes the difference between null and an object.\nReturn a representational string of a given data type.\n\n**element**: element type to check.\n\n```js\nimport { typeOf, log } from '@cahmoraes93/utils'\n\nlog(typeOf(null))\n//=> null\nlog(typeof null) // using typeof native operator\n//=> object\nlog(typeOf({}))\n//=> object\nlog(typeOf(() => {}))\n//=> function\nlog(typeOf('this is a string'))\n//=> string\nlog(typeOf(0))\n//=> number\nlog(typeOf(undefined))\n//=> undefined\n```\n\n
\n\n# isPrimitive\n\n```ts\n- isPrimitive(element: any): boolean\n```\n\nUsed to check if a given data type is a primitive or non-primitive data type.\n\n**element**: element to check if it is primitive.\n\n```js\nimport { isPrimitive, log } from '@cahmoraes93/utils'\n\nlog(isPrimitive(null))\n//=> true\nlog(isPrimitive({}))\n//=> false\nlog(isPrimitive(() => {}))\n//=> false\nlog(isPrimitive('this is a string'))\n//=> true\nlog(isPrimitive(0))\n//=> true\nlog(isPrimitive(undefined))\n//=> true\n```\n\n
\n\n# curry\n\n```ts\n- curry(function: (args: any) => any): Function\n```\n\nUsed to create curried functions.\nCurrying is a transformation of functions that translates a function from callable as f(a, b, c) into callable as f(a)(b)(c).\nThe Curry function doesn’t call a function. It just transforms it.\n\n**function**: function that to apply curry pattern.\n\n```js\nimport { curry, log } from '@cahmoraes93/utils'\n\nconst sum = (a, b, c) => {\n return a + b + c\n}\n\nconst curriedSum = curry(sum)\n\nlog(curriedSum(1, 2, 3))\n//=> 6, still callable normally\nlog(curriedSum(1)(2, 3))\n//=> 6, currying of 1st arg\nlog(curriedSum(1)(2)(3))\n//=> 6, full currying\n```\n\n
\n\n# debounce\n\n```ts\n- debounce(callback: () => void, milliseconds: number = 200): Function\n```\n\nUsed to implement a debounce pattern.\nThis pattern schedules a task to fire in the future after a specified time. It guarantees that any call to the same function during this interval will be canceled, and a new schedule for the callback function will be fired after the scheduled time.\n\nThe debouncing pattern ensures that your code only fires once for each user input. Search box suggestions, automatic text box saves, and the elimination of button double clicks are all use cases for debounce.\n\n**callback**: callback function that will be fired after only milliseconds.\n\n**milliseconds**: The milliseconds quantity that callback will wait until triggered.\n\n```js\nimport { debounce, log } from '@cahmoraes93/utils'\n\nconst doThing = () => {\n log('hi!!')\n}\n\nconst callback = debounce(doThing, 300)\n// the second parameter is optional. Default is 200\n\ncallback() // <- this function will be cancelled\ncallback() // <- this function will be cancelled\ncallback() // <- this function will be cancelled\ncallback() // <- only this function will be called after 300 milliseconds\n//=> hi!!\n```\n\n
\n\n# takeUntil\n\n```ts\n- takeUntil(callback: () => void, times: number = infinity): Function\n```\n\nUsed to create a function that can be called a certain number of times. If the number of calls is greater than the configured number of times, the undefined value will be returned.\n\nThis function guarantees that your function will only be called a certain number of times. By default, it can be activated infinite times.\n\n**callback**: callback function will be fired a certain number of times.\n\n**times**: number of times the function can be called\n\n```js\nimport { takeUntil, log } from '@cahmoraes93/utils'\n\nconst doThing = () => {\n log('hi!!')\n}\n\nconst fn = takeUntil(doThing, 2)\n// the second parameter is optional. Default is 200\n\nfn() //=> 'hi!!'\nfn() //=> 'hi!!'\nfn() //=> undefined\nfn() //=> undefined\n```\n\n
\n\n# deepFreeze\n\n```ts\n- deepFreeze(structure: any): any\n```\n\nIt is used to recursively freeze arrays, objects, maps, and structures sets.\nThis function does not create a clone of the structure passed by parameter.\n\nThis function use Object.freezes recursively in the structure param.\nTo create a deep clone with immutability, use:\n\nnpm i @cahmoraes93/simple-immuter@latest
\n\n**structure**: Array, Map, Set, or Object Structure to realize Deep Freeze.\n\n
\n\n```js\nimport { deepFreeze, log } from '@cahmoraes93/utils'\n\nconst user = {\n name: 'John Doe',\n age: 29,\n address: {\n street: 'Baker',\n number: null,\n },\n books: ['sapiens'],\n}\n\nconst isFrozen = (obj) => Object.isFrozen(obj)\n\ndeepFreeze(user)\n\nlog(isFrozen(user))\n//=> true\nlog(isFrozen(user.address))\n//=> true\nlog(isFrozen(user.books))\n//=> true\n\nuser.books.push('Rápido e Devagar - Duas Formas de Pensar')\n\nlog(user.books)\n//=> ['sapiens']\n```\n\n
\n\n# mixin\n\n```ts\n- mixin(target: any, ...objects: any[]): any\n```\n\nUsed to apply the mixin pattern.\nThis pattern is used to compose multiple objects into a target object.\n\n
\n\n**target**: target-object to receive the objects' properties.\n\n**objects**: in target-object, one or more objects must be composed.\n\n```js\nimport { mixin, log } from '@cahmoraes93/utils'\n\nconst user = {\n name: 'John Doe',\n age: 29,\n address: {\n street: 'Baker',\n number: null,\n },\n}\n\nconst job = {\n greeting() {\n return `Hello, my name's ${this.name}`\n },\n}\n\nconst result = mixin(user, job, { hobbies: ['books'] })\n\nlog(result)\n/*\n{\n name: 'John Doe',\n age: 29,\n address: {\n street: 'Baker',\n number: null,\n },\n greeting() {\n return `Hello, my name's ${this.name}`\n },\n hobbies: ['books']\n}\n*/\n\nlog(result.greeting())\n//=> Hello, my name's John Doe\n```\n\n
\n\n# pipe\n\n```ts\n- pipe(value: any, ...operations: ((value: any) => any)[]): any\n```\n\nUsed to transform a value by a pipeline.\n\nEach function in the pipeline should receive the value passed from the previous function, which is mapped by the other functions in the pipeline.\nThis pipe function is not working with promises. For this, use the asyncPipe function.\n\nThis transformation occurs from left to right.\n\n
\n\n**value**: value that will be transform at the pipeline.\n\n**operations**: One or more callback functions (operations) to transform the value in the pipeline.\n\n```js\nimport { pipe, log } from '@cahmoraes93/utils'\n\nconst double = (n1) => n1 * 2\nconst triple = (n1) => n1 * 3\n\nconst result = pipe(3, double, triple)\n\nlog(result)\n//=> 18\n```\n\n
\n\n# asyncPipe\n\n```ts\n- asyncPipe(value: any, ...operations: ((value: any) => Promise)[]): Promise\n```\n\nUsed to transform a value by an async pipeline. It's an async version of the pipe function, but it works with promises.\nEach function in the pipeline should receive the value passed from the previous function, which is mapped by the other functions in the pipeline.\n\nThis transformation occurs from left to right.\n\n
\n\n**value**: value to be transformed in the pipeline\n\n**operations**: One or more callback functions to transform the value in the pipeline.\n\n```js\nimport { asyncPipe, log } from '@cahmoraes93/utils'\n\nconst double = (n1) => Promise.resolve(n1 * 2)\nconst triple = (n1) => Promise.resolve(n1 * 3)\n\nconst transformValue = await asyncPipe(Promise.resolve(3), double, triple)\n\nlog(result)\n//=> 18\n```\n\n
\n\n# checkInterface\n\n```ts\n- checkInterface(anObject: any, ...keys: string[]): boolean\n```\n\nCheck if a given object is type of an interface.\n\n
\n\n**Interface**: interface to be check. This type parameter is used to ensure the intellisense.\n\n**anObject**: an object to check.\n\n**keys**: keys from interface to match in object.\n\n```ts\nimport { checkInterface, log } from '@cahmoraes93/utils'\n\ninterface IProduct {\n name: string\n price: number\n}\n\nconst anProductSample: Product = {\n name: 'book',\n price: 18.99,\n}\n\nconst isProduct = checkInterface(anProductSample, 'name', 'price')\nlog(isProduct) //=> true\n\nconst aNotProductSample = {\n name: 'book',\n}\n\nconst nonProduct = checkInterface(aNotProductSample, 'name', 'price')\n\nlog(nonProduct) //=> false\n```\n\n# makeMap\n\n```ts\n- makeMap(anObject: Record): Map\n```\n\nCreates a Map data structure from an object\n\n
\n\n**anObject**: an Object to create a Map.\n\n```ts\nimport { makeMap, log } from '@cahmoraes93/utils'\n\nconst user {\n name: 'John',\n age: 29,\n}\n\nconst userMap = makeMap(user)\nlog(userMap instanceof Map) //=> true\nlog(userMap.get('name')) //=> 'John'\nlog(userMap.has('age')) //=> true\n\n```\n","readmeFilename":"readme.md","homepage":"https://github.com/Cahmoraes/utils#readme","repository":{"type":"git","url":"git+https://github.com/Cahmoraes/utils.git"},"bugs":{"url":"https://github.com/Cahmoraes/utils/issues"}}