@stdlib/string-for-each 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,177 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
package/NOTICE ADDED
@@ -0,0 +1 @@
1
+ Copyright (c) 2016-2023 The Stdlib Authors.
package/README.md ADDED
@@ -0,0 +1,237 @@
1
+ <!--
2
+
3
+ @license Apache-2.0
4
+
5
+ Copyright (c) 2023 The Stdlib Authors.
6
+
7
+ Licensed under the Apache License, Version 2.0 (the "License");
8
+ you may not use this file except in compliance with the License.
9
+ You may obtain a copy of the License at
10
+
11
+ http://www.apache.org/licenses/LICENSE-2.0
12
+
13
+ Unless required by applicable law or agreed to in writing, software
14
+ distributed under the License is distributed on an "AS IS" BASIS,
15
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ See the License for the specific language governing permissions and
17
+ limitations under the License.
18
+
19
+ -->
20
+
21
+ # forEach
22
+
23
+ [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
24
+
25
+ > Invokes a function for each character in a string.
26
+
27
+ <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
28
+
29
+ <section class="intro">
30
+
31
+ </section>
32
+
33
+ <!-- /.intro -->
34
+
35
+ <!-- Package usage documentation. -->
36
+
37
+ <section class="installation">
38
+
39
+ ## Installation
40
+
41
+ ```bash
42
+ npm install @stdlib/string-for-each
43
+ ```
44
+
45
+ </section>
46
+
47
+ <section class="usage">
48
+
49
+ ## Usage
50
+
51
+ ```javascript
52
+ var forEach = require( '@stdlib/string-for-each' );
53
+ ```
54
+
55
+ #### forEach( str, \[options,] clbk\[, thisArg ] )
56
+
57
+ Invokes a function for each character in a string.
58
+
59
+ ```javascript
60
+ function log( value, index ) {
61
+ console.log( '%d: %s', index, value );
62
+ }
63
+
64
+ forEach( 'Beep!', log );
65
+ /* =>
66
+ 0: B
67
+ 1: e
68
+ 2: e
69
+ 3: p
70
+ 4: !
71
+ */
72
+ ```
73
+
74
+ The invoked function is provided three arguments:
75
+
76
+ - **value**: character.
77
+ - **index**: starting character index.
78
+ - **str**: input string.
79
+
80
+ To set the function execution context, provide a `thisArg`.
81
+
82
+ ```javascript
83
+ function clbk() {
84
+ this.count += 1;
85
+ }
86
+
87
+ var str = 'Hello, world!';
88
+
89
+ var ctx = {
90
+ 'count': 0
91
+ };
92
+
93
+ forEach( str, clbk, ctx );
94
+
95
+ var bool = ( str.length === ctx.count );
96
+ // returns true
97
+ ```
98
+
99
+ The function supports the following options:
100
+
101
+ - **mode**: type of characters over which to iterate. Must be one of the following:
102
+
103
+ - `'grapheme'`: grapheme clusters. Appropriate for strings containing visual characters which can span multiple Unicode code points (e.g., emoji).
104
+ - `'code_point'`: Unicode code points. Appropriate for strings containing visual characters which are comprised of more than one Unicode code unit (e.g., ideographic symbols and punctuation and mathematical alphanumerics).
105
+ - `'code_unit'`: UTF-16 code units. Appropriate for strings containing visual characters drawn from the basic multilingual plane (BMP) (e.g., common characters, such as those from the Latin, Greek, and Cyrillic alphabets).
106
+
107
+ Default: `'grapheme'`.
108
+
109
+ </section>
110
+
111
+ <!-- /.usage -->
112
+
113
+ <!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
114
+
115
+ <section class="notes">
116
+
117
+ ## Notes
118
+
119
+ - By default, the function assumes the general case in which an input string may contain an arbitrary number of grapheme clusters. This assumption comes with a performance cost. Accordingly, if an input string is known to only contain visual characters of a particular type (e.g., only alphanumeric), one can achieve better performance by specifying the appropriate `mode` option.
120
+
121
+ </section>
122
+
123
+ <!-- /.notes -->
124
+
125
+ <!-- Package usage examples. -->
126
+
127
+ <section class="examples">
128
+
129
+ ## Examples
130
+
131
+ <!-- eslint no-undef: "error" -->
132
+
133
+ ```javascript
134
+ var forEach = require( '@stdlib/string-for-each' );
135
+
136
+ function log( value, index ) {
137
+ console.log( '%d: %s', index, value );
138
+ }
139
+
140
+ forEach( 'presidential election', log );
141
+ forEach( 'Iñtërnâtiônàlizætiøn', log );
142
+ forEach( '🌷🍕', log );
143
+ forEach( '\uD834\uDD1E', log );
144
+ ```
145
+
146
+ </section>
147
+
148
+ <!-- /.examples -->
149
+
150
+ <!-- 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. -->
151
+
152
+ <section class="references">
153
+
154
+ </section>
155
+
156
+ <!-- /.references -->
157
+
158
+ <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
159
+
160
+ <section class="related">
161
+
162
+ </section>
163
+
164
+ <!-- /.related -->
165
+
166
+ <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
167
+
168
+
169
+ <section class="main-repo" >
170
+
171
+ * * *
172
+
173
+ ## Notice
174
+
175
+ This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
176
+
177
+ For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
178
+
179
+ #### Community
180
+
181
+ [![Chat][chat-image]][chat-url]
182
+
183
+ ---
184
+
185
+ ## License
186
+
187
+ See [LICENSE][stdlib-license].
188
+
189
+
190
+ ## Copyright
191
+
192
+ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
193
+
194
+ </section>
195
+
196
+ <!-- /.stdlib -->
197
+
198
+ <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
199
+
200
+ <section class="links">
201
+
202
+ [npm-image]: http://img.shields.io/npm/v/@stdlib/string-for-each.svg
203
+ [npm-url]: https://npmjs.org/package/@stdlib/string-for-each
204
+
205
+ [test-image]: https://github.com/stdlib-js/string-for-each/actions/workflows/test.yml/badge.svg?branch=v0.0.1
206
+ [test-url]: https://github.com/stdlib-js/string-for-each/actions/workflows/test.yml?query=branch:v0.0.1
207
+
208
+ [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-for-each/main.svg
209
+ [coverage-url]: https://codecov.io/github/stdlib-js/string-for-each?branch=main
210
+
211
+ <!--
212
+
213
+ [dependencies-image]: https://img.shields.io/david/stdlib-js/string-for-each.svg
214
+ [dependencies-url]: https://david-dm.org/stdlib-js/string-for-each/main
215
+
216
+ -->
217
+
218
+ [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
219
+ [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
220
+
221
+ [stdlib]: https://github.com/stdlib-js/stdlib
222
+
223
+ [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
224
+
225
+ [umd]: https://github.com/umdjs/umd
226
+ [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
227
+
228
+ [deno-url]: https://github.com/stdlib-js/string-for-each/tree/deno
229
+ [umd-url]: https://github.com/stdlib-js/string-for-each/tree/umd
230
+ [esm-url]: https://github.com/stdlib-js/string-for-each/tree/esm
231
+ [branches-url]: https://github.com/stdlib-js/string-for-each/blob/main/branches.md
232
+
233
+ [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-for-each/main/LICENSE
234
+
235
+ </section>
236
+
237
+ <!-- /.links -->
@@ -0,0 +1,140 @@
1
+ /*
2
+ * @license Apache-2.0
3
+ *
4
+ * Copyright (c) 2023 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
+ // TypeScript Version: 2.0
20
+
21
+ /**
22
+ * Interface describing function options.
23
+ */
24
+ interface Options {
25
+ /**
26
+ * Specifies the type of characters over which to iterate (default: 'grapheme').
27
+ *
28
+ * ## Notes
29
+ *
30
+ * - The following option values are supported:
31
+ *
32
+ * - `'grapheme'`: grapheme clusters. Appropriate for strings containing visual characters which can span multiple Unicode code points (e.g., emoji).
33
+ * - `'code_point'`: Unicode code points. Appropriate for strings containing visual characters which are comprised of more than one Unicode code unit (e.g., ideographic symbols and punctuation and mathematical alphanumerics).
34
+ * - `'code_unit'`: UTF-16 code units. Appropriate for strings containing visual characters drawn from the basic multilingual plane (BMP) (e.g., common characters, such as those from the Latin, Greek, and Cyrillic alphabets).
35
+ */
36
+ mode?: 'grapheme' | 'code_point' | 'code_unit';
37
+ }
38
+
39
+ /**
40
+ * Callback invoked for each character in a string.
41
+ *
42
+ * @returns result
43
+ */
44
+ type Nullary = () => any;
45
+
46
+ /**
47
+ * Callback invoked for each character in a string.
48
+ *
49
+ * @param value - character
50
+ * @returns result
51
+ */
52
+ type Unary = ( value: string ) => any;
53
+
54
+ /**
55
+ * Callback invoked for each character in a string.
56
+ *
57
+ * @param value - character
58
+ * @param index - starting character index
59
+ * @returns result
60
+ */
61
+ type Binary = ( value: string, index: number ) => any;
62
+
63
+ /**
64
+ * Callback invoked for each character in a string.
65
+ *
66
+ * @param value - character
67
+ * @param index - starting character index
68
+ * @param str - input string
69
+ * @returns result
70
+ */
71
+ type Ternary = ( value: string, index: number, str: string ) => any;
72
+
73
+ /**
74
+ * Callback invoked for each character in a string.
75
+ *
76
+ * @param value - character
77
+ * @param index - starting character index
78
+ * @param str - input string
79
+ * @returns result
80
+ */
81
+ type Callback = Nullary | Unary | Binary | Ternary;
82
+
83
+ /**
84
+ * Invokes a function for each character in a string.
85
+ *
86
+ * ## Notes
87
+ *
88
+ * - When invoked, the provided function is provided three arguments:
89
+ *
90
+ * - **value**: character.
91
+ * - **index**: starting character index.
92
+ * - **str**: input string.
93
+ *
94
+ * @param str - input string
95
+ * @param clbk - function to invoke
96
+ * @param thisArg - execution context
97
+ * @returns input string
98
+ *
99
+ * @example
100
+ * function log( value, index ) {
101
+ * console.log( '%d: %s', index, value );
102
+ * }
103
+ *
104
+ * forEach( 'Hello, World!', log );
105
+ */
106
+ declare function forEach( str: string, clbk: Callback, thisArg?: any ): string;
107
+
108
+ /**
109
+ * Invokes a function for each character in a string.
110
+ *
111
+ * ## Notes
112
+ *
113
+ * - When invoked, the provided function is provided three arguments:
114
+ *
115
+ * - **value**: character.
116
+ * - **index**: starting character index.
117
+ * - **str**: input string.
118
+ *
119
+ * @param str - input string
120
+ * @param options - options
121
+ * @param clbk - function to invoke
122
+ * @param thisArg - execution context
123
+ * @returns input string
124
+ *
125
+ * @example
126
+ * function log( value, index ) {
127
+ * console.log( '%d: %s', index, value );
128
+ * }
129
+ *
130
+ * var opts = {
131
+ * 'mode': 'code_point'
132
+ * };
133
+ * forEach( 'Hello, World!', opts, log );
134
+ */
135
+ declare function forEach( str: string, options: Options, clbk: Callback, thisArg?: any ): string;
136
+
137
+
138
+ // EXPORTS //
139
+
140
+ export = forEach;
package/lib/index.js ADDED
@@ -0,0 +1,43 @@
1
+ /**
2
+ * @license Apache-2.0
3
+ *
4
+ * Copyright (c) 2023 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
+ * Invoke a function for each character in a string.
23
+ *
24
+ * @module @stdlib/string-for-each
25
+ *
26
+ * @example
27
+ * var forEach = require( '@stdlib/string-for-each' );
28
+ *
29
+ * function log( value, index ) {
30
+ * console.log( '%d: %s', index, value );
31
+ * }
32
+ *
33
+ * forEach( 'Hello', log );
34
+ */
35
+
36
+ // MODULES //
37
+
38
+ var main = require( './main.js' );
39
+
40
+
41
+ // EXPORTS //
42
+
43
+ module.exports = main;
package/lib/main.js ADDED
@@ -0,0 +1,116 @@
1
+ /**
2
+ * @license Apache-2.0
3
+ *
4
+ * Copyright (c) 2023 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
+ // MODULES //
22
+
23
+ var isFunction = require( '@stdlib/assert-is-function' );
24
+ var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
25
+ var isPlainObject = require( '@stdlib/assert-is-plain-object' );
26
+ var hasOwnProp = require( '@stdlib/assert-has-own-property' );
27
+ var contains = require( '@stdlib/array-base-assert-contains' ).factory;
28
+ var forEachCodeUnit = require( '@stdlib/string-base-for-each' );
29
+ var forEachCodePoint = require( '@stdlib/string-base-for-each-code-point' );
30
+ var forEachGraphemeCluster = require( '@stdlib/string-base-for-each-grapheme-cluster' );
31
+ var format = require( '@stdlib/string-format' );
32
+
33
+
34
+ // VARIABLES //
35
+
36
+ var MODES = [ 'grapheme', 'code_point', 'code_unit' ];
37
+ var FCNS = {
38
+ 'grapheme': forEachGraphemeCluster,
39
+ 'code_point': forEachCodePoint,
40
+ 'code_unit': forEachCodeUnit
41
+ };
42
+ var isMode = contains( MODES );
43
+
44
+
45
+ // MAIN //
46
+
47
+ /**
48
+ * Invokes a function for each character in a string.
49
+ *
50
+ * @param {string} str - input string
51
+ * @param {Options} [options] - options
52
+ * @param {string} [options.mode="grapheme"] - type of "character" over which to iterate (must be either `grapheme`, `code_point`, or `code_unit`)
53
+ * @param {Function} clbk - function to invoke
54
+ * @param {*} [thisArg] - execution context
55
+ * @throws {TypeError} first argument must be a string
56
+ * @throws {TypeError} callback argument must be a function
57
+ * @throws {TypeError} options argument must be an object
58
+ * @throws {TypeError} must provide valid options
59
+ * @returns {string} input string
60
+ *
61
+ * @example
62
+ * function log( value, index ) {
63
+ * console.log( '%d: %s', index, value );
64
+ * }
65
+ *
66
+ * forEach( 'Hello', log );
67
+ */
68
+ function forEach( str, options, clbk ) {
69
+ var thisArg;
70
+ var nargs;
71
+ var opts;
72
+ var cb;
73
+ if ( !isString( str ) ) {
74
+ throw new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', str ) );
75
+ }
76
+ opts = {
77
+ 'mode': 'grapheme'
78
+ };
79
+ nargs = arguments.length;
80
+ if ( nargs === 2 ) {
81
+ cb = options;
82
+ options = null;
83
+ } else if ( nargs === 3 ) {
84
+ if ( isPlainObject( options ) ) {
85
+ cb = clbk;
86
+ } else {
87
+ cb = options;
88
+ options = null;
89
+ thisArg = clbk;
90
+ }
91
+ } else { // nargs === 4
92
+ if ( !isPlainObject( options ) ) {
93
+ throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
94
+ }
95
+ cb = clbk;
96
+ thisArg = arguments[ 3 ];
97
+ }
98
+ if ( !isFunction( cb ) ) {
99
+ throw new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', cb ) );
100
+ }
101
+ if ( options ) {
102
+ if ( hasOwnProp( options, 'mode' ) ) {
103
+ opts.mode = options.mode;
104
+ if ( !isMode( opts.mode ) ) {
105
+ throw new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Value: `%s`.', 'mode', MODES.join( '", "' ), opts.mode ) );
106
+ }
107
+ }
108
+ }
109
+ FCNS[ opts.mode ]( str, cb, thisArg );
110
+ return str;
111
+ }
112
+
113
+
114
+ // EXPORTS //
115
+
116
+ module.exports = forEach;
package/package.json ADDED
@@ -0,0 +1,96 @@
1
+ {
2
+ "name": "@stdlib/string-for-each",
3
+ "version": "0.0.1",
4
+ "description": "Invoke a function for each character in a string.",
5
+ "license": "Apache-2.0",
6
+ "author": {
7
+ "name": "The Stdlib Authors",
8
+ "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
9
+ },
10
+ "contributors": [
11
+ {
12
+ "name": "The Stdlib Authors",
13
+ "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
14
+ }
15
+ ],
16
+ "main": "./lib",
17
+ "directories": {
18
+ "benchmark": "./benchmark",
19
+ "doc": "./docs",
20
+ "example": "./examples",
21
+ "lib": "./lib",
22
+ "test": "./test"
23
+ },
24
+ "types": "./docs/types",
25
+ "scripts": {
26
+ "test": "make test",
27
+ "test-cov": "make test-cov",
28
+ "examples": "make examples",
29
+ "benchmark": "make benchmark"
30
+ },
31
+ "homepage": "https://stdlib.io",
32
+ "repository": {
33
+ "type": "git",
34
+ "url": "git://github.com/stdlib-js/string-for-each.git"
35
+ },
36
+ "bugs": {
37
+ "url": "https://github.com/stdlib-js/stdlib/issues"
38
+ },
39
+ "dependencies": {
40
+ "@stdlib/array-base-assert-contains": "^0.0.1",
41
+ "@stdlib/assert-has-own-property": "^0.0.7",
42
+ "@stdlib/assert-is-function": "^0.0.8",
43
+ "@stdlib/assert-is-plain-object": "^0.0.7",
44
+ "@stdlib/assert-is-string": "^0.0.8",
45
+ "@stdlib/string-base-for-each": "^0.0.1",
46
+ "@stdlib/string-base-for-each-code-point": "^0.0.1",
47
+ "@stdlib/string-base-for-each-grapheme-cluster": "^0.0.1",
48
+ "@stdlib/string-format": "^0.0.3"
49
+ },
50
+ "devDependencies": {
51
+ "@stdlib/bench": "^0.0.12",
52
+ "@stdlib/utils-noop": "^0.0.14",
53
+ "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
54
+ "istanbul": "^0.4.1",
55
+ "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
56
+ },
57
+ "engines": {
58
+ "node": ">=0.10.0",
59
+ "npm": ">2.7.0"
60
+ },
61
+ "os": [
62
+ "aix",
63
+ "darwin",
64
+ "freebsd",
65
+ "linux",
66
+ "macos",
67
+ "openbsd",
68
+ "sunos",
69
+ "win32",
70
+ "windows"
71
+ ],
72
+ "keywords": [
73
+ "stdlib",
74
+ "stdutils",
75
+ "stdutil",
76
+ "utilities",
77
+ "utility",
78
+ "utils",
79
+ "util",
80
+ "for",
81
+ "each",
82
+ "foreach",
83
+ "iterate",
84
+ "stdstring",
85
+ "string",
86
+ "str",
87
+ "grapheme",
88
+ "unicode",
89
+ "utf16",
90
+ "utf-16"
91
+ ],
92
+ "funding": {
93
+ "type": "opencollective",
94
+ "url": "https://opencollective.com/stdlib"
95
+ }
96
+ }