Files
common/packages/util/src/is/string.ts
T
Jaco Greeff 18a202c460 Bump dev w/ eslint (#603)
* Bump dev w/ eslint

* Mop-up remaining lint issues

* Update stringShorten expectation
2020-05-23 14:23:13 +02:00

23 lines
678 B
TypeScript

// Copyright 2017-2020 @polkadot/util authors & contributors
// This software may be modified and distributed under the terms
// of the Apache-2.0 license. See the LICENSE file for details.
/**
* @name isString
* @summary Tests for a string.
* @description
* Checks to see if the input value is a JavaScript string.
* @example
* <BR>
*
* ```javascript
* import { isString } from '@polkadot/util';
*
* console.log('isString', isString('test')); // => true
* ```
*/
// eslint-disable-next-line @typescript-eslint/ban-types
export default function isString (value: unknown): value is string | String {
return typeof value === 'string' || value instanceof String;
}