Options
All
  • Public
  • Public/Protected
  • All
Menu

Module string/snakeCaseName

Index

References

Functions

References

Renames and re-exports snakeCaseName

Functions

  • snakeCaseName(str: string): string
  • Returns the snake case version of a string.

    This function convert only latin chars. The preferred purpose is to generate file or class names in your code generation tools.

    example
     snakeCaseName('Foo Bar'); //=> 'foo_bar'
    snakeCaseName('fooBar'); //=> 'foo_bar'
    snakeCaseName('foo-bar'); //=> 'foo_bar'
    snakeCaseName('FOO-BAR'); //=> 'foo_bar'
    snakeCaseName('Foo Bär'); //=> 'foo_bär' only latin chars are supported

    Parameters

    • str: string

      The string to switch to snake case.

    Returns string

    The snake case version of str.

Generated using TypeDoc