Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trs/astype
:inbox_tray: Convert an unknown type to a string, boolean, or number (integer, or float)
https://github.com/trs/astype
Last synced: 10 days ago
JSON representation
:inbox_tray: Convert an unknown type to a string, boolean, or number (integer, or float)
- Host: GitHub
- URL: https://github.com/trs/astype
- Owner: trs
- License: mit
- Created: 2016-07-15T18:08:50.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-20T03:43:46.000Z (over 6 years ago)
- Last Synced: 2024-10-02T18:46:52.538Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 29.3 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# astype [![NPM version][npm-image]][npm-url]
> Convert an unknown type to a string, boolean, or number (integer, or float)
* [Installation](#installation)
* [Usage](#usage)
* [Options](#options)
## Installation
```sh
$ npm install --save astype
```
## Usage
```js
import as from 'astype';
as.number('1'); // 1
as.integer('55.1'); // 55
as.boolean(0); // false
as.string(true); // "true"
```
### Available conversions
* `number(...)` (aliases: `double()`, `float()`)
* allows decimal places (1.1)
* `integer(...)`
* truncates decimal places (1.1 => 1)
* `boolean(...)` (aliases: `bool()`)
* `string(...)`
## Options
Options can be used to modify the behavior of the conversions.
These can be set in two ways:
* [Global](#global) will affect the behavior anytime that function is used
* [Query](#query) will affect the behavior in that instance
### Global
Setting a global option will modify the behavior anytime a function is called.
This allows simplier syntax when using the same rules.
```js
as.setGlobal({
number: { ... },
boolean: { ... },
string: { ... }
});
```
You can also unset global options as well.
Passing an empty object or null will unset all options under that key.
```js
as.unsetGlobal({
number: { ... },
boolean: { ... },
string: { ... }
})
```
### Query
You can also pass through options in the conversion.
This will change the behavior in this instance, but will not change any globally set options.
**these take presidence over any global options**.
```js
as.number(..., { ... })
```
```js
as.number(null, { allowNull: false }); // 0
```
### Available Options
#### `number`
* **allowNull** (default: `true`)
* If `true`: conversion can return the value `null`
* If `false`: conversion will return `0` if `null`
* **allowUndefined** (default: `true`)
* If `true`: conversion can return the value `undefined`
* If `false`: conversion will return `0` if `undefined`
* **allowNaN** (default: `true`)
* If `true`: conversion can return the value `NaN`
* If `false`: conversion will return `0` if `NaN`
* **allowInfinity** (default: `true`)
* If `true`: conversion can return the value `Infinity`
* If `false`: conversion will return `0` if `Infinity`
* **allowFindInString** (default: `true`)
* If `true`: conversion can will pick out numbers from a string
(eg: 'abc123!' => 123)
* If `false`: conversion will return `NaN` if **allowNaN** is `true`,
otherwise `0`
* **allowDecimals** (default: `true`)
* If `true`: will allow decimal places in numbers
(eg: '1.9' => 1.9)
* If `false`: will truncate decimal places
(eg: '1.9' => 1)
#### `boolean`
* **allowNull** (default: `true`)
* If `true`: conversion can return the value `null`
* If `false`: conversion will return `0` if `null`
* **allowUndefined** (default: `true`)
* If `true`: conversion can return the value `undefined`
* If `false`: conversion will return `0` if `undefined`
* **parseString** (default: `true`)
* If `true`: will parse the strings `"true"` and `"false"` to `true`
and `false` respectively
* If `false`: will parse the string to a boolean (`Boolean("string")`)
* **convertNumbers** (default: `true`)
* If `true`: if the input is a number (or string that is a number),
it will parse as a number first, then convert to a boolean
(eg: '1' => 1 => true)
* If `false`: will parse the string to a boolean (`Boolean(1)`)
#### `string`
* **allowNull** (default: `true`)
* If `true`: conversion can return the value `null`
* If `false`: conversion will return `0` if `null`
* **allowUndefined** (default: `true`)
* If `true`: conversion can return the value `undefined`
* If `false`: conversion will return `0` if `undefined`
## License
MIT © [Tyler Stewart]()
[npm-image]: https://badge.fury.io/js/astype.svg
[npm-url]: https://npmjs.org/package/astype