-
-
Notifications
You must be signed in to change notification settings - Fork 447
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: refactor remove-last API with base string packages
- Loading branch information
Showing
44 changed files
with
2,470 additions
and
66 deletions.
There are no files selected for viewing
2 changes: 1 addition & 1 deletion
2
lib/node_modules/@stdlib/string/base/remove-first-code-point/package.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
lib/node_modules/@stdlib/string/base/remove-first-grapheme-cluster/package.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
95 changes: 95 additions & 0 deletions
95
lib/node_modules/@stdlib/string/base/remove-last-code-point/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
<!-- | ||
@license Apache-2.0 | ||
Copyright (c) 2023 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. | ||
--> | ||
|
||
# removeLastCodePoint | ||
|
||
> Remove the last `n` Unicode code points of a string. | ||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
```javascript | ||
var removeLastCodePoint = require( '@stdlib/string/base/remove-last-code-point' ); | ||
``` | ||
|
||
#### removeLastCodePoint( str, n ) | ||
|
||
Removes the last `n` Unicode code points of a string. | ||
|
||
```javascript | ||
var out = removeLastCodePoint( 'last man standing', 1 ); | ||
// returns 'last man standin' | ||
|
||
out = removeLastCodePoint( 'Hidden Treasures', 1 ); | ||
// returns 'Hidden Treasure' | ||
|
||
out = removeLastCodePoint( 'foo bar', 5 ); | ||
// returns 'fo' | ||
|
||
out = removeLastCodePoint( 'foo bar', 10 ); | ||
// returns '' | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<section class="examples"> | ||
|
||
## Examples | ||
|
||
<!-- eslint no-undef: "error" --> | ||
|
||
```javascript | ||
var removeLastCodePoint = require( '@stdlib/string/base/remove-last-code-point' ); | ||
|
||
var str = removeLastCodePoint( 'presidential election', 1 ); | ||
// returns 'presidential electio' | ||
|
||
str = removeLastCodePoint( 'JavaScript', 1 ); | ||
// returns 'JavaScrip' | ||
|
||
str = removeLastCodePoint( 'The Last of the Mohicans', 5 ); | ||
// returns 'The Last of the Moh' | ||
|
||
str = removeLastCodePoint( 'अनुच्छेद', 1 ); | ||
// returns 'अनुच्छे' | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.examples --> | ||
|
||
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> | ||
|
||
<section class="related"> | ||
|
||
</section> | ||
|
||
<!-- /.related --> | ||
|
||
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
||
<section class="links"> | ||
|
||
</section> | ||
|
||
<!-- /.links --> |
56 changes: 56 additions & 0 deletions
56
lib/node_modules/@stdlib/string/base/remove-last-code-point/benchmark/benchmark.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2023 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'; | ||
|
||
// MODULES // | ||
|
||
var bench = require( '@stdlib/bench' ); | ||
var isString = require( '@stdlib/assert/is-string' ).isPrimitive; | ||
var pkg = require( './../package.json' ).name; | ||
var removeLast = require( './../lib' ); | ||
|
||
|
||
// MAIN // | ||
|
||
bench( pkg, function benchmark( b ) { | ||
var values; | ||
var out; | ||
var i; | ||
|
||
values = [ | ||
'beep boop', | ||
'foo bar', | ||
'xyz abc', | ||
'🐶🐮🐷🐰🐸' | ||
]; | ||
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
out = removeLast( values[ i%values.length ], 1 ); | ||
if ( typeof out !== 'string' ) { | ||
b.fail( 'should return a string' ); | ||
} | ||
} | ||
b.toc(); | ||
if ( !isString( out ) ) { | ||
b.fail( 'should return a string' ); | ||
} | ||
b.pass( 'benchmark finished' ); | ||
b.end(); | ||
}); |
29 changes: 29 additions & 0 deletions
29
lib/node_modules/@stdlib/string/base/remove-last-code-point/docs/repl.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
|
||
{{alias}}( str, n ) | ||
Removes the last `n` Unicode code points of a string. | ||
|
||
Parameters | ||
---------- | ||
str: string | ||
Input string. | ||
|
||
n: integer | ||
Number of Unicode code points to remove. | ||
|
||
Returns | ||
------- | ||
out: string | ||
Output string. | ||
|
||
Examples | ||
-------- | ||
> var out = {{alias}}( 'beep', 1 ) | ||
'bee' | ||
> out = {{alias}}( 'Boop', 1 ) | ||
'Boo' | ||
> out = {{alias}}( 'foo bar', 5 ) | ||
'fo' | ||
|
||
See Also | ||
-------- | ||
|
53 changes: 53 additions & 0 deletions
53
lib/node_modules/@stdlib/string/base/remove-last-code-point/docs/types/index.d.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
/* | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2023 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. | ||
*/ | ||
|
||
// TypeScript Version: 2.0 | ||
|
||
/** | ||
* Removes the last `n` Unicode code points of a string. | ||
* | ||
* @param str - input string | ||
* @param n - number of code points to remove | ||
* @returns output string | ||
* | ||
* @example | ||
* var out = removeLast( 'last man standing', 1 ); | ||
* // returns 'last man standin' | ||
* | ||
* @example | ||
* var out = removeLast( 'presidential election', 1 ); | ||
* // returns 'presidential electio' | ||
* | ||
* @example | ||
* var out = removeLast( 'JavaScript', 1 ); | ||
* // returns 'JavaScrip' | ||
* | ||
* @example | ||
* var out = removeLast( 'Hidden Treasures', 1 ); | ||
* // returns 'Hidden Treasure' | ||
* | ||
* @example | ||
* var out = removeLast( 'foo bar', 5 ); | ||
* // returns 'fo' | ||
*/ | ||
declare function removeLast( str: string, n: number ): string; | ||
|
||
|
||
// EXPORTS // | ||
|
||
export = removeLast; |
57 changes: 57 additions & 0 deletions
57
lib/node_modules/@stdlib/string/base/remove-last-code-point/docs/types/test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
/* | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2023 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. | ||
*/ | ||
|
||
import removeLast = require( './index' ); | ||
|
||
|
||
// TESTS // | ||
|
||
// The function returns a string... | ||
{ | ||
removeLast( 'abc', 1 ); // $ExpectType string | ||
} | ||
|
||
// The compiler throws an error if the function is provided a value other than a string... | ||
{ | ||
removeLast( true, 1 ); // $ExpectError | ||
removeLast( false, 1 ); // $ExpectError | ||
removeLast( null, 1 ); // $ExpectError | ||
removeLast( undefined, 1 ); // $ExpectError | ||
removeLast( 5, 1 ); // $ExpectError | ||
removeLast( [], 1 ); // $ExpectError | ||
removeLast( {}, 1 ); // $ExpectError | ||
removeLast( ( x: number ): number => x, 1 ); // $ExpectError | ||
} | ||
|
||
// The compiler throws an error if the function is provided a second argument that is not a number... | ||
{ | ||
removeLast( 'abc', true ); // $ExpectError | ||
removeLast( 'abc', false ); // $ExpectError | ||
removeLast( 'abc', null ); // $ExpectError | ||
removeLast( 'abc', 'abc' ); // $ExpectError | ||
removeLast( 'abc', [] ); // $ExpectError | ||
removeLast( 'abc', {} ); // $ExpectError | ||
removeLast( 'abc', ( x: number ): number => x ); // $ExpectError | ||
} | ||
|
||
// The compiler throws an error if the function is provided an unsupported number of arguments... | ||
{ | ||
removeLast(); // $ExpectError | ||
removeLast( 'abc' ); // $ExpectError | ||
removeLast( 'abc', 1, 2 ); // $ExpectError | ||
} |
33 changes: 33 additions & 0 deletions
33
lib/node_modules/@stdlib/string/base/remove-last-code-point/examples/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2023 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'; | ||
|
||
var removeLastCodePoint = require( './../lib' ); | ||
|
||
console.log( removeLastCodePoint( 'presidential election', 1 ) ); | ||
// => 'presidential electio' | ||
|
||
console.log( removeLastCodePoint( 'JavaScript', 1 ) ); | ||
// => 'JavaScrip' | ||
|
||
console.log( removeLastCodePoint( 'The Last of the Mohicans', 5 ) ); | ||
// => 'The Last of the Moh' | ||
|
||
console.log( removeLastCodePoint( 'अनुच्छेद', 1 ) ); | ||
// => 'अनुच्छे' |
43 changes: 43 additions & 0 deletions
43
lib/node_modules/@stdlib/string/base/remove-last-code-point/lib/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2023 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'; | ||
|
||
/** | ||
* Remove the last `n` Unicode code points of a string. | ||
* | ||
* @module @stdlib/string/base/remove-last-code-point | ||
* | ||
* @example | ||
* var removeLast = require( '@stdlib/string/base/remove-last-code-point' ); | ||
* | ||
* var out = removeLast( 'last man standing', 1 ); | ||
* // returns 'last man standin' | ||
* | ||
* out = removeLast( 'Hidden Treasures', 1 ); | ||
* // returns 'Hidden Treasure'; | ||
*/ | ||
|
||
// MODULES // | ||
|
||
var main = require( './main.js' ); | ||
|
||
|
||
// EXPORTS // | ||
|
||
module.exports = main; |
Oops, something went wrong.