index.js (1088B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Replace search occurrences with a replacement string. 23 * 24 * @module @stdlib/string/replace 25 * 26 * @example 27 * var replace = require( '@stdlib/string/replace' ); 28 * 29 * var str = 'beep'; 30 * var out = replace( str, 'e', 'o' ); 31 * // returns 'boop' 32 * 33 * str = 'Hello World'; 34 * out = replace( str, /world/i, 'Mr. President' ); 35 * // returns 'Hello Mr. President' 36 */ 37 38 // MODULES // 39 40 var replace = require( './replace.js' ); 41 42 43 // EXPORTS // 44 45 module.exports = replace;