External module "string/acronym/docs/types/index.d"

Export assignment acronym

• acronym(str: string, options?: Options): string

• Generates an acronym for a given string.

  Parameters

  • str: string

    input string

  • Optional options: Options

    function options

  Returns string

  generated acronym

  Example

  var out = acronym( 'the quick brown fox' );
  // returns 'QBF'

  Example

  var out = acronym( 'Hard-boiled eggs' );
  // returns 'HBE'

  Example

  var out = acronym( 'National Association of Securities Dealers Automated Quotation' );
  // returns 'NASDAQ'