Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Feb 27, 2024
1 parent 3d8f4f4 commit 7ff88e2
Show file tree
Hide file tree
Showing 11 changed files with 748 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@ Amit Jimiwal <[email protected]>
Athan Reines <[email protected]>
Brendan Graetz <[email protected]>
Bruno Fenzl <[email protected]>
Chinmay J <[email protected]>
Christopher Dambamuromo <[email protected]>
Dan Rose <[email protected]>
Daniel Killenberger <[email protected]>
Dominik Moritz <[email protected]>
Dorrin Sotoudeh <[email protected]>
Frank Kovacs <[email protected]>
GUNJ JOSHI <[email protected]>
Golden <[email protected]>
Harshita Kalani <[email protected]>
James Gelok <[email protected]>
Jaysukh Makvana <[email protected]>
Expand All @@ -24,6 +26,7 @@ Jordan Gallivan <[email protected]>
Joris Labie <[email protected]>
Justin Dennison <[email protected]>
Karthik Prakash <[email protected]>
Khaldon <[email protected]>
Marcus Fantham <[email protected]>
Matt Cochrane <[email protected]>
Milan Raj <[email protected]>
Expand All @@ -34,12 +37,16 @@ Ognjen Jevremović <[email protected]>
Philipp Burckhardt <[email protected]>
Prajwal Kulkarni <[email protected]>
Pranav Goswami <[email protected]>
Praneki <[email protected]>
Pratik <[email protected]>
Ricky Reusser <[email protected]>
Robert Gislason <[email protected]>
Roman Stetsyk <[email protected]>
Rutam <[email protected]>
Ryan Seal <[email protected]>
Seyyed Parsa Neshaei <[email protected]>
Shraddheya Shendre <[email protected]>
Shubham <[email protected]>
Spandan Barve <[email protected]>
Stephannie Jiménez Gacha <[email protected]>
Yernar Yergaziyev <[email protected]>
Expand Down
132 changes: 132 additions & 0 deletions base/replace-after-last/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
<!--
@license Apache-2.0
Copyright (c) 2024 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.
-->

# replaceAfterLast

> Replace the substring after the last occurrence of a specified search string.
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- Package usage documentation. -->

<section class="usage">

## Usage

```javascript
var replaceAfterLast = require( '@stdlib/string/base/replace-after-last' );
```

#### replaceAfterLast( str, search, replacement, fromIndex )

Replaces the substring after the last occurrence of a specified search string.

```javascript
var str = 'beep boop';
var out = replaceAfterLast( str, ' ', 'loop', str.length );
// returns 'beep loop'

out = replaceAfterLast( str, 'o', 'bar', str.length );
// returns 'beep boobar'
```

</section>

<!-- /.usage -->

<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

## Notes

- If a search string is not present in a provided string, the function returns the provided string unchanged.
- If a search string is an empty string, the function returns the provided string unchanged.
- If `fromIndex` is less than `0`, the function returns the provided string unchanged.

</section>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var replaceAfterLast = require( '@stdlib/string/base/replace-after-last' );

var str = 'beep boop';
var out = replaceAfterLast( str, 'p', 'see', str.length );
// returns 'beep boopsee'

str = 'Hello World!';
out = replaceAfterLast( str, 'xyz', 'foo', str.length );
// returns 'Hello World!'

str = 'Hello World!';
out = replaceAfterLast( str, '', 'foo', str.length );
// returns 'Hello World!'

str = '';
out = replaceAfterLast( str, 'xyz', 'foo', str.length );
// returns ''

str = 'beep boop beep baz';
out = replaceAfterLast( str, 'beep', 'foo', 5 );
// return 'beepfoo'
```

</section>

<!-- /.examples -->

<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="references">

</section>

<!-- /.references -->

<!-- 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 -->
58 changes: 58 additions & 0 deletions base/replace-after-last/benchmark/benchmark.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2024 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 replaceAfterLast = require( './../lib' );


// MAIN //

bench( pkg, function benchmark( b ) {
var values;
var out;
var str;
var i;

str = 'To be, or not to be, that is the question.';
values = [
'foo',
'bar',
'beep',
'boop'
];

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
out = replaceAfterLast( str, 'T', values[ i%values.length ], str.length );
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();
});
37 changes: 37 additions & 0 deletions base/replace-after-last/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@

{{alias}}( str, search, replacement, fromIndex )
Replaces the substring after the last occurrence of a specified search
string.

Parameters
----------
str: string
Input string.

search: string
Search string.

replacement: string
Replacement string.

fromIndex: integer
Index from which to start searching.

Returns
-------
out: string
Output string.

Examples
--------
> var str = 'beep boop';
> var out = {{alias}}( str, ' ', 'foo', str.length )
'beep foo'
> out = {{alias}}( str, 'o', 'foo', str.length )
'beep boofoo'
> out = {{alias}}( 'Hello World!', 'o', 'foo', 5 )
'Hellofoo'

See Also
--------

65 changes: 65 additions & 0 deletions base/replace-after-last/docs/types/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2024 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: 4.1

/**
* Replaces the substring after the last occurrence of a specified search string.
*
* @param str - input string
* @param search - search string
* @param replacement - replacement string
* @param fromIndex - index from which to start searching
* @returns output string
*
* @example
* var str = 'beep boop';
* var out = replaceAfterLast( str, ' ', 'foo', str.length );
* // returns 'beep foo'
*
* @example
* var str = 'beep boop';
* var out = replaceAfterLast( str, 'p', 'foo', str.length );
* // returns 'beep boopfoo'
*
* @example
* var str = 'Hello World!';
* var out = replaceAfterLast( str, '', 'foo', str.length );
* // returns 'Hello World!'
*
* @example
* var str = 'Hello World!';
* var out = replaceAfterLast( str, 'xyz', 'foo', str.length );
* // returns 'Hello World!'
*
* @example
* var str = 'beep boop baz';
* var out = replaceAfterLast( str, 'p b', 'foo', str.length );
* // returns 'beep boop bfoo'
*
* @example
* var str = 'beep boop baz';
* var out = replaceAfterLast( str, 'p b', 'foo', 6 );
* // returns 'beep bfoo'
*/
declare function replaceAfterLast( str: string, search: string, replacement: string, fromIndex: number ): string;


// EXPORTS //

export = replaceAfterLast;
Loading

0 comments on commit 7ff88e2

Please sign in to comment.