A collection of utility functions for processing options.

Install

• npm

  npm install --save-dev @guanghechen/option-helper

• yarn

  yarn add --dev @guanghechen/option-helper

Usage

• is

  Name | Description :--------------------:|:---------------------------------------------------------------- isArray | Check if the given data is a Array type isBigint | Check if the given data is a bigint type isBoolean | Check if the given data is a boolean / Boolean type isDate | Check if the given data is a Date type isFunction | Check if the given data is a Function type isInteger | Check if the given data is a Integer type isNumber | Check if the given data is a number / Number type isObject | Check if the given data is a Object type isString | Check if the given data is a string / String type isSymbol | Check if the given data is a symbol type isUndefined | Check if the given data is a undefined type isPrimitiveBoolean | Check if the given data is a boolean type isPrimitiveInteger | Check if the given data is a integer type isPrimitiveNumber | Check if the given data is a number type isPrimitiveString | Check if the given data is a string type isNonBlankString | Check if the given data is an non-blank string / String type isNotEmptyArray | Check if the given data is an not-empty Array type isNotEmptyObject | Check if the given data is an not-empty Object type isEmptyObject | Check if the given data is an empty Object type isNumberLike | Check if the given data is an number / Number or number like string type

• string utilities

  Name | Description :--------------------:|:--------------------------------------- toCamelCase | 'test string' => 'testString' toCapitalCase | 'test string' => 'Test String' toConstantCase | 'test string' => 'TEST_STRING' toDotCase | 'test string' => 'test.string' toKebabCase | 'test string' => 'test-string' toLowerCase | 'TEST STRING' => 'test string' toPascalCase | 'test string' => 'TestString' toPathCase | 'test string' => 'test/string' toSentenceCase | 'testString' => 'Test string' toSnakeCase | 'test string' => 'test_string' toTitleCase | 'a simple test' => 'A Simple Test' toUpperCase | 'test string' => 'TEST STRING'

  • composeTextTransformers: Compose multiple TextTransformer into one.

    import {
      composeTextTransformers,
      toKebabCase,
      toTrim,
    } from '@guanghechen/option-helper'
    
    // function composeTextTransformers (
    //   ...transformers: ReadonlyArray<TextTransformer>
    // ): TextTransformer
    
    const transform = composeTextTransformers(toTrim, toKebabCase)
    const text: string = transform(' TeSt_StrinG ')
    // => 'test-string'

• cover utilities

  Name | Description :--------------------:|:--------------------------------------- cover | - coverBoolean | - coverInteger | - coverNumber | - coverString | -

• convert utilities

  Name | Description :--------------------:|:--------------------------------------- convertToBoolean | - convertToInteger | - convertToNumber | - convertToString | -