\n\nCollection of utility functions/helpers I use in my everyday development.\n\n## Methods\n\n\ncapitalize\nThis method is used to capitalize a string.\n\n* **value** string to be capitalize\n\n```js\nconst { capitalize } = require('@bolajiolajide/utils');\n\nconst data = capitalize('bolaji');\nconsole.log(data);\n// 'Bolaji'\n```\n\n\n\nconvertSliceToString\nThis method is used to convert a string slice into a string.\n\n* **value** string slice to convert\n* **separator** string to use to separate the different items in the slice\n\n```js\nconst { convertSliceToString } = require('@bolajiolajide/utils');\n\nconst data = convertSliceToString('bolaji');\nconsole.log(data);\n// 'bolaji'\n\nconst data2 = convertSliceToString(['bol', 'aji']);\nconsole.log(data2);\n// 'bolaji'\n\nconst data3 = convertSliceToString(['bol', 'aji', 'pro', 'ton'], '**');\nconsole.log(data3);\n// 'bol**aji**pro**ton'\n```\n\n\n\n\n\ncountries\nThis is a list of countries all over the world. It's a pretty long list.\n\n```js\nconst { countries } = require('@bolajiolajide/utils');\n\nconsole.log(countries);\n// ['Afghanistan', ...]\n```\n\n\n\ndelay\nThis method is used to add a delay to an async method. It takes in one argument which is the amount of milliseconds\nto delay.\n\n```js\nconst { delay } = require('@bolajiolajide/utils');\n\nawait delay(10000); // delay for 10seconds\n```\n\n\n\ngenerateCSV\nThis method is used to generate a csv string from an array of objects. It takes in array of objects with a key-value type of string. The output is a string which will be the records in the array delimited by a comma.\n\n```js\nconst { generateCSV } = require('@bolajiolajide/utils');\n\nconst data = [\n { name: 'John Doe', age: 20 },\n { name: 'Jane Doe', age: 23 }\n];\nconst csv = generateCSV(data);\nconsole.log(csv);\n// name, age\n// John Doe, 20\n// Jane Doe, 23\n```\n\n\n\ngenerateShortCode\nThis method is used to generate a not so unique shortcode.\nThe default shortcode length is 5.\n\n```js\nconst { generateShortCode } = require('@bolajiolajide/utils');\n\nconst shortcode = generateShortCode(10);\nconsole.log(shortcode);\n// 637010000\n```\n\n\n\nisDict\nThis method returns a boolean depending on whether the argument supplied is a dictionary.\n\n* **value** literal to check type\n\n```js\nconst { isDict } = require('@bolajiolajide/utils');\n\nconst data = isDict('bolaji');\nconsole.log(data);\n// false\n\nconst data2 = isDict({ amount: 230329 });\nconsole.log(data2);\n// true\n```\n\n\n\nisString\nThis method returns a boolean depending on whether the argument supplied is a string.\n\n* **value** literal to check type\n\n```js\nconst { isString } = require('@bolajiolajide/utils');\n\nconst data = isString('bolaji');\nconsole.log(data);\n// true\n\nconst data2 = isString(230329);\nconsole.log(data2);\n// false\n```\n\n\n\nrunOnce\nThis method is used to set a function to run only once.\nIt's argumument is:\n\n* **fn** the function to be run only once\n\n```js\nconst { runOnce } = require('@bolajiolajide/utils');\n\nconst addTogether = function(num1:number, num2:number):number{\n return num1+num2\n}\nconst addTogetherOnce = runOnce(addTogether)\nlet firstResult = addTogetherOnce(0,1)\nlet secondResult = addTogetherOnce(0,1)\nconsole.log(firstResult)\nconsole.log(secondResult)\n});\n// firstResult: 1\n// secondResult: undefined\n```\n\n\n\npaginate\nThis method is used to lazily paginate an array of items.\nIt can be used for client-side pagination where no server exists.\nIt's argumumets are:\n\n* **limit** how many items to receive per page\n* **page** page number to be retrieved\n* **data** the array of data to be paginated\n\n```js\nconst { paginate } = require('@bolajiolajide/utils');\n\nconst data = paginate(2, 2, [\n 'Jane',\n 'John',\n 'James',\n 'Bill',\n 'Steve',\n 'Melissa',\n 'Esther',\n 'Shannon'\n]);\nconsole.log(data);\n// ['James', 'Bill']\n```\n\n\n\nsentencize\nThis method is used to capitalize several words in a phrase depending on the separator.\nIt's argumumets are:\n\n* **word** the word/phrase to sentencize\n* **separator** a string separating the words in a phrase, defaults to ' '\n\n```js\nconst { sentencize } = require('@bolajiolajide/utils');\n\nconst data = sentencize('APPLE_MUSIC', '_');\nconsole.log(data);\n// 'Apple Music'\n\nconst data = sentencize('SPOTIFY');\nconsole.log(data);\n// 'Spotify'\n```\n\n\n\nisUrl\nThis method is used to check if a string is a valid URL\n\n* **url** the url to be checked\n\n```js\nconst { isUrl } = require('@bolajiolajide/utils');\n\nconst response = isUrl('APPLE_MUSIC');\nconsole.log(response);\n// false\n\nconst response = isUrl('https://google.com');\nconsole.log(response);\n// true\n```\n\n\n\nisHttpUrl\nThis method is used to check if a string is a valid http URL\n\n* **url** the url to be checked\n\n```js\nconst { isHttpUrl } = require('@bolajiolajide/utils');\n\nconst response = isHttpUrl('ftp://dskjdslds');\nconsole.log(response);\n// false\n\nconst response = isUrl('https://google.com');\nconsole.log(response);\n// true\n```\n\n","readmeFilename":"README.md","homepage":"https://github.com/BolajiOlajide/utils","bugs":{"url":"https://github.com/BolajiOlajide/utils/issues"}}
![\"alfred](\"https://github.com/BolajiOlajide/utils/blob/master/alfred.png?raw=true\")