time-to-botec/js/node_modules/@stdlib/string/acronym/lib/index.js

46 lines
1.1 KiB
JavaScript
Raw Normal View History

/**
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
/**
* Generate an acronym for a given string.
*
* @module @stdlib/string/acronym
*
* @example
* var acronym = require( '@stdlib/string/acronym' );
*
* var out = acronym( 'National Association of Securities Dealers Automated Quotation' );
* // returns 'NASDAQ'
*
* out = acronym( 'To be determined...', {
* 'stopwords': []
* });
* // returns 'TBD'
*/
// MODULES //
var acronym = require( './main.js' );
// EXPORTS //
module.exports = acronym;