Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abhijithvijayan/ts-utils
Collection of JavaScript utility functions
https://github.com/abhijithvijayan/ts-utils
javascript utils
Last synced: 19 days ago
JSON representation
Collection of JavaScript utility functions
- Host: GitHub
- URL: https://github.com/abhijithvijayan/ts-utils
- Owner: abhijithvijayan
- License: mit
- Created: 2021-05-11T09:41:45.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-15T15:07:35.000Z (over 2 years ago)
- Last Synced: 2024-10-15T03:03:32.974Z (28 days ago)
- Topics: javascript, utils
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@abhijithvijayan/ts-utils
- Size: 67.4 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: license
Awesome Lists containing this project
README
@abhijithvijayan/ts-utils
Collection of JavaScript utility functions
🙋♂️ Made by @abhijithvijayan
❤️ it? ⭐️ it on [GitHub](https://github.com/abhijithvijayan/ts-utils/stargazers) or [Tweet](https://twitter.com/intent/tweet?text=Check%20out%20%40abhijithvijayan%2Fts-utils%21%20by%20%40_abhijithv%0A%0ACollection%20of%20JavaScript%20utility%20functions%0Ahttps%3A%2F%2Fgithub.com%2Fabhijithvijayan%2Fts-utils%0A%0A%23node%20%23javascript%20%23typescript%20%23utils%20%23npm) about it.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [API](#api)
- [Issues](#issues)
- [🐛 Bugs](#-bugs)
- [Credits](#credits)
- [LICENSE](#license)
## Installation
Ensure you have [Node.js](https://nodejs.org) 10 or later installed. Then run the following:
```
# via npm
npm install @abhijithvijayan/ts-utils
# or yarn
yarn add @abhijithvijayan/ts-utils
```
## Usage
```js
import {isNull, get} from '@abhijithvijayan/ts-utils';
```
## API
- `isEmail(value)`: Performs [RFC2822 Validation](https://datatracker.ietf.org/doc/html/rfc2822#section-3.4.1) to email
- `isEmail("[email protected]");` // `true`
- `isEmail("[email protected]");` // `false`
- `isNull(value)`: Returns `true` if value is `null`, `false` otherwise
- `isUndefined(value)`: Returns `true` if value is `undefined`, `false` otherwise
- `isNullOrUndefined(value)`: Returns `true` if value is `null` or `undefined`, `false` otherwise
- `isString(value)`: Returns `true` if value is `string`, `false` otherwise
- `isNumber(value)`: Returns `true` if value is `number`, `false` otherwise
- `isFunction(value)`: Returns `true` if value is `function`, `false` otherwise
- `isEmpty(value)`: Returns `true` if the value is an `empty object`, `collection`, has `no enumerable properties` or is any type that is not considered a `collection`
- isEmpty([]); // true
- isEmpty({}); // true
- isEmpty(""); // true
- isEmpty([1, 2]); // false
- isEmpty({ a: 1, b: 2 }); // false
- isEmpty("text"); // false
- isEmpty(123); // true - type is not considered a collection
- isEmpty(true); // true - type is not considered a collection
- `size(value)`: Gets the size of an array, object, set or string
- size([1, 2, 3, 4, 5]); // 5
- size("size"); // 4
- size(new Set([1, 2, 3])); // 3
- size({ one: 1, two: 2, three: 3 }); // 3
- `splitArrayIntoChunks(arr, size)`: Splits array into chunks of arrays, Returns `array`
- splitArrayIntoChunks([0, 1, 2, 3, 4], 2); // [[0, 1], [2, 3], [4]]
- splitArrayIntoChunks([0, 1, 2, 3, 4], 4); // [[0, 1, 2, 3], [4]]
- `removeWhitespaces(value)`: Remove all whitespaces from a `string`
- removeWhitespaces("-- hello - world --"); // "--hello-world--"
- `capitalize(value, lowerRest)`: Capitalizes the first letter of a `string`
- `lowerRest`, if `true`, lower-cases the rest of the string, `Default: false`
- capitalize("fooBar"); // 'FooBar'
- capitalize("fooBar", true); // 'Foobar'
- `toCamelCase(value)`: Converts a string to camelcase
- toCamelCase("some_text_field_name"); // 'someTextFieldName'
- toCamelCase("Some label that needs to be camelized"); // 'someLabelThatNeedsToBeCamelized'
- toCamelCase("some-js-property"); // 'someJsProperty'
- toCamelCase("some-mixed_string with spaces_underscores-and-hyphens"); // 'someMixedStringWithSpacesUnderscoresAndHyphens'
- `randomString()`: Generates a random `string`
- `randomNumberInRange(min, max)`: Returns a random number between min (inclusive) and max (exclusive)
- randomNumberInRange(10, 15); // 12.257101242652775
- `randomIntegerInRange(min, max`: Returns a random `integer` between min (inclusive) and max (inclusive)
- randomIntegerInRange(10, 20); // 16
- `round(num, decimals)`: Rounds a number to a specified amount of digits
- round(1.005, 2); // 1.01
- `mask(value, num, maskWith)`: Replaces all, but the last num of characters with the specified mask character
- If `num` is negative, the unmasked characters will be at the start of the string. `Default: 4`
- `maskWith` changes default character for the mask. `Default: *`
- mask(1234567890); // '******7890'
- mask(1234567890, 3); // '*******890'
- mask(1234567890, -4, "$"); // '$$$$567890'
- `fillArray(prop, value)`: Initializes and fills an array with the specified values, Returns an `array`
- `prop`: if `number` is passed, it will be used as the array size
- `prop`: can be an object as well
- `length`: array size
- `value`: value to fill
- `fillIndex`: if `true`, the array will be filled with index value (overrides value field)
- fillArray(5, 2); // [2, 2, 2, 2, 2]
- fillArray(3, {}); // [{}, {}, {}]
- fillArray(1, null); // [null]
- fillArray({length: 2, value: 'test'}); // ['test', 'test']
- fillArray({length: 5, fillIndex: true}); // [0, 1, 2, 3, 4]
- `unique(arr)`: Returns all unique values in an array
- unique([1, 2, 2, 3, 4, 4, 5]); // [1, 2, 3, 4, 5]
- `take(arr)`: Returns an array with n elements taken from the beginning
- take([1, 2, 3], 5); // [1, 2, 3]
- take([1, 2, 3], 0); // []
- `last(arr)`: Returns the last element in an array
- last([1, 2, 3]); // 3
- last([]); // undefined
- last([null]); // null
- last(undefined); // undefined
- `flatten(arr, depth)`: Flattens an array to specified depth, Returns `array`
- `depth`, if passed, array will be flattened to the specified depth, else array will be flattened completely
- flatten([1, [2, [3, [4, 5], 6], 7], 8]); // [1, 2, 3, 4, 5, 6, 7, 8]
- flatten([1, [2, [3, [4, 5], 6], 7], 8], 2); // [1, 2, 3, [4, 5], 6, 7, 8]
- `pipe(...fns)`: Performs left-to-right function composition(synchronous)
```js
const add5 = (x) => x + 5;
const multiply = (x, y) => x * y;
const multiplyAndAdd5 = pipe(multiply, add5);
multiplyAndAdd5(5, 2); // 15
```
- `get(from, selector, defaultValue)`: Retrieve a property indicated by the given selector from an object
```js
const obj = { selector: { to: { val: "val to select" } }, target: [1, 2, { a: "test" }], };
get(obj, "selector.to.val"); //"val to select"
get(obj, "selector.to1.val", null); // null
get(obj, "target.2.a"); // "test"
get(obj, "selector.to1.val"); // undefined
get(obj, "selector[to][val]"); // "val to select"
get(obj, "target.2.[a]"); // "test"
get(null, "something"); // undefined
get(undefined, "something", 123); // 123
```
- `debounce(fn, wait)`: Creates a debounced function that delays invoking func until after wait milliseconds have elapsed since the last time the debounced function was invoked
- `wait`: Time in milliseconds `Default: 100`
```js
window.addEventListener("resize", debounce(() => {
console.log(window.innerWidth);
console.log(window.innerHeight);
}, 250)); // Will log the window dimensions at most every 250ms
```
- `throttle(fn, wait)`: Creates a throttled function that only invokes `fn` at most once per `wait` milliseconds
- `wait`: Time in milliseconds `Default: 100`
- `sleep(ms)`: Delays the execution of an asynchronous function
- `ms`: Time in milliseconds `Default: 100`
```js
async function sleepyWork() {
console.log("I'm going to sleep for 1 second.");
await sleep(1000);
console.log("I woke up after 1 second.");
}
```
- `objectToQueryParams(queryParams)`: Returns a query string generated from the key-value pairs of the given object
- Note:
- `undefined` and `NaN` values(nested) will be skipped automatically
- value will be `empty string` for `functions` and `null`
- `nested arrays` will be flattened
- objectToQueryParams(undefined); // ""
- objectToQueryParams(null); // ""
- objectToQueryParams({}); // ""
- objectToQueryParams({ page: "1", limit: "10", key: undefined }); // 'page=1&limit=10'
- With a complex object that has nested values
```js
objectToQueryParams({
foo: 'hello world', // resolves to [ "foo", "hello world" ]
bar: {
blah: 123, // resolves to [ "bar[blah]", "123" ]
list: [1, 2, 3], // resolves to [ "bar[list][]", "1" ], [ "bar[list][]", "2" ], [ "bar[list][]", "3" ]
'nested array': [[4,5],[6,7]] // resolves to [ "bar[nested array][][]", "4" ], [ "bar[nested array][][]", "5" ], [ "bar[nested array][][]", "6" ], [ "bar[nested array][][]", "7" ]
},
page: 1, // resolves to [ "page", "1" ]
limit: undefined, // ignored
check: false, // resolves to [ "check", "false" ]
max: NaN, // ignored
prop: null, // resolves to [ "prop", "" ]
' key value': 'with spaces' // resolves to [ "key value", "with spaces" ]
}); // foo=hello%20world&bar[blah]=123&bar[list][]=1&bar[list][]=2&bar[list][]=3&bar[nested%20array][][]=4&bar[nested%20array][][]=5&bar[nested%20array][][]=6&bar[nested%20array][][]=7&page=1&check=false&prop=&key%20value=with%20spaces
let params = new URLSearchParams(window.location.search);
for (const param of p) {
console.log(param); // [ "foo", "hello world" ], [ "bar[blah]", "123" ], ...
}
```
- `isBrowser()`: Determines if the current runtime environment is a browser
- `isIP(str)`: Tests if input is an IP address
- Returns
- `0` for invalid strings, // eg: `1.1.1.01`, `1::2::3`
- `4` for IP version 4 addresses, // eg: `127.0.0.1`, `192.168.1.1`
- `6` for IP version 6 addresses, // eg: `1::`, `ff02::1`, `1:2:3:4::6:7:8`
## Issues
_Looking to contribute? Look for the [Good First Issue](https://github.com/abhijithvijayan/ts-utils/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
label._
### 🐛 Bugs
Please file an issue [here](https://github.com/abhijithvijayan/ts-utils/issues/new) for bugs, missing documentation, or unexpected behavior.
[**See Bugs**](https://github.com/abhijithvijayan/ts-utils/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22type%3A+bug%22)
### Linting & TypeScript Config
- Shared Eslint & Prettier Configuration - [`@abhijithvijayan/eslint-config`](https://www.npmjs.com/package/@abhijithvijayan/eslint-config)
- Shared TypeScript Configuration - [`@abhijithvijayan/tsconfig`](https://www.npmjs.com/package/@abhijithvijayan/tsconfig)
## Credits
Some utils are inherited from https://www.30secondsofcode.org/js/p/1
## License
MIT © [Abhijith Vijayan](https://abhijithvijayan.in)