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

44 lines
1017 B
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';
/**
* Truncate a string to a specified length.
*
* @module @stdlib/string/truncate
*
* @example
* var truncate = require( '@stdlib/string/truncate' );
*
* var out = truncate( 'beep boop', 7 );
* // returns 'beep...'
*
* out = truncate( 'beep boop', 7, '|' );
* // returns 'beep b|'
*/
// MODULES //
var truncate = require( './main.js' );
// EXPORTS //
module.exports = truncate;