@fav/type.is-string
Version:
Checks whether a value is a string or not.
134 lines (87 loc) • 4.27 kB
Markdown
# [@fav/type.is-string][repo-url] [![NPM][npm-img]][npm-url] [![MIT License][mit-img]][mit-url] [![Build Status][travis-img]][travis-url] [![Build Status][appveyor-img]][appveyor-url] [![Coverage status][coverage-img]][coverage-url]
Checks whether a value is a string or not.
> "fav" is an abbreviation of "favorite" and also the acronym of "for all versions".
> This package is intended to support all Node.js versions and many browsers as possible.
> At least, this package supports Node.js >= v0.10 and major Web browsers: Chrome, Firefox, IE11, Edge, Vivaldi and Safari.
## Install
To install from npm:
```sh
$ npm install --save @fav/type.is-string
```
***NOTE:*** *npm < 2.7.0 does not support scoped package, but old version Node.js supports it. So when you use such older npm, you should download this package from [github.com][repo-url], and move it in `node_modules/@fav/type.is-string/` directory manually.*
## Usage
For Node.js:
```js
var isString = require('@fav/type.is-string');
isString('abc'); // => true
isString.not('abc'); // => false
```
For Web browsers:
```html
<script src="fav.type.is-string.min.js"></script>
<script>
var isString = fav.type.isString;
isString('abc'); // => true
isString.not('abc'); // => false
</script>
```
## API
### <u>isString(value) : boolean</u>
Checks if *value* is an string.
#### Parameter:
| Parameter | Type | Description |
|-----------|:------:|---------------------------|
| value | *any* | The value to be checked. |
#### Return:
True, if *value* is a string.
**Type:** boolean
### <u>isString.not(value) : boolean</u>
Checks if *value* is not an string.
This function always returns a negative boolean of `isString(value)`.
#### Parameter:
| Parameter | Type | Description |
|-----------|:------:|---------------------------|
| value | *any* | The value to be checked. |
#### Return:
True, if *value* is not a string.
**Type:** boolean
## Checked
### Node.js (4〜)
| Platform | 4 | 5 | 6 | 7 | 8 | 9 | 10 |
|:---------:|:------:|:------:|:------:|:------:|:------:|:------:|:------:|
| macOS |◯|◯|◯|◯|◯|◯|◯|
| Windows10 |◯|◯|◯|◯|◯|◯|◯|
| Linux |◯|◯|◯|◯|◯|◯|◯|
### io.js (1〜3)
| Platform | 1 | 2 | 3 |
|:---------:|:------:|:------:|:------:|
| macOS |◯|◯|◯|
| Windows10 |◯|◯|◯|
| Linux |◯|◯|◯|
### Node.js (〜0.12)
| Platform | 0.8 | 0.9 | 0.10 | 0.11 | 0.12 |
|:---------:|:------:|:------:|:------:|:------:|:------:|
| macOS |◯|◯|◯|◯|◯|
| Windows10 |◯|◯|◯|◯|◯|
| Linux |◯|◯|◯|◯|◯|
### Web browsers
| Platform | Chrome | Firefox | Vivaldi | Safari | Edge | IE11 |
|:---------:|:------:|:-------:|:-------:|:------:|:------:|:------:|
| macOS |◯|◯ |◯ |◯| -- | -- |
| Windows10 |◯|◯ |◯ | -- |◯|◯|
| Linux |◯|◯ |◯ | -- | -- | -- |
## License
Copyright (C) 2017-2018 Takayuki Sato
This program is free software under [MIT][mit-url] License.
See the file LICENSE in this distribution for more details.
[repo-url]: https://github.com/sttk/fav-type.is-string/
[npm-img]: https://img.shields.io/badge/npm-v1.0.2-blue.svg
[npm-url]: https://www.npmjs.com/package/@fav/type.is-string
[mit-img]: https://img.shields.io/badge/license-MIT-green.svg
[mit-url]: https://opensource.org/licenses/MIT
[travis-img]: https://travis-ci.org/sttk/fav-type.is-string.svg?branch=master
[travis-url]: https://travis-ci.org/sttk/fav-type.is-string
[appveyor-img]: https://ci.appveyor.com/api/projects/status/github/sttk/fav-type.is-string?branch=master&svg=true
[appveyor-url]: https://ci.appveyor.com/project/sttk/fav-type-is-string
[coverage-img]: https://coveralls.io/repos/github/sttk/fav-type.is-string/badge.svg?branch=master
[coverage-url]: https://coveralls.io/github/sttk/fav-type.is-string?branch=master