Skip to content

Commit 39a9582

Browse files
docs(isString): update jsdoc
1 parent 6355919 commit 39a9582

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

packages/type/src/is/lib/is-string.func.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import { ResultCallback } from '../../type/result-callback.type';
1111
* @param value Any `value` to check.
1212
* @param callback `ResultCallback` function to handle result before returns.
1313
* @callback `resultCallback`.
14-
* @returns A `boolean` indicating whether or not the `value` is a `string`.
14+
* @returns A `boolean` indicating whether or not the `value` is a `string` type or `String` object.
1515
*/
1616
export const isString: IsString = (value: any, callback: ResultCallback = resultCallback): value is string =>
1717
callback(typeOf(value) === 'string' && (isStringType(value) || isStringObject(value)), value);

0 commit comments

Comments
 (0)