Skip to content

Commit 0a1cc94

Browse files
kgrytekgryte
committed
Add namespace
1 parent 26f3b06 commit 0a1cc94

File tree

5 files changed

+260
-0
lines changed

5 files changed

+260
-0
lines changed

‎lib/node_modules/@stdlib/simulate/iter/README.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2019 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+
# Simulation Iterators
22+
23+
> Standard library simulation iterators.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var ns = require( '@stdlib/simulate/iter' );
31+
```
32+
33+
#### ns
34+
35+
Standard library simulation iterators.
36+
37+
```javascript
38+
var iterators = ns;
39+
// returns {...}
40+
```
41+
42+
The namespace contains the following functions for creating iterator protocol-compliant iterators:
43+
44+
<!-- <toc pattern="*"> -->
45+
46+
<!-- </toc> -->
47+
48+
</section>
49+
50+
<!-- /.usage -->
51+
52+
<section class="examples">
53+
54+
## Examples
55+
56+
<!-- TODO: better examples -->
57+
58+
<!-- eslint no-undef: "error" -->
59+
60+
```javascript
61+
var objectKeys = require( '@stdlib/utils/keys' );
62+
var ns = require( '@stdlib/simulate/iter' );
63+
64+
console.log( objectKeys( ns ) );
65+
```
66+
67+
</section>
68+
69+
<!-- /.examples -->
70+
71+
<section class="links">
72+
73+
</section>
74+
75+
<!-- /.links -->

‎lib/node_modules/@stdlib/simulate/iter/examples/index.js

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2019 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+
var objectKeys = require( '@stdlib/utils/keys' );
22+
var ns = require( './../lib' );
23+
24+
console.log( objectKeys( ns ) );

‎lib/node_modules/@stdlib/simulate/iter/lib/index.js

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2019 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+
* When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.
23+
*/
24+
25+
// MODULES //
26+
27+
var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
28+
29+
30+
// MAIN //
31+
32+
/**
33+
* Top-level namespace.
34+
*
35+
* @namespace ns
36+
*/
37+
var ns = {};
38+
39+
/**
40+
* @name iterPulseWave
41+
* @memberof ns
42+
* @readonly
43+
* @type {Function}
44+
* @see {@link module:@stdlib/simulate/iter/pulse-wave}
45+
*/
46+
setReadOnly( ns, 'iterPulseWave', require( '@stdlib/simulate/iter/pulse-wave' ) );
47+
48+
/**
49+
* @name iterSquareWave
50+
* @memberof ns
51+
* @readonly
52+
* @type {Function}
53+
* @see {@link module:@stdlib/simulate/iter/square-wave}
54+
*/
55+
setReadOnly( ns, 'iterSquareWave', require( '@stdlib/simulate/iter/square-wave' ) );
56+
57+
58+
// EXPORTS //
59+
60+
module.exports = ns;

‎lib/node_modules/@stdlib/simulate/iter/package.json

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
{
2+
"name": "@stdlib/simulate/iter",
3+
"version": "0.0.0",
4+
"description": "Standard library simulation iterators.",
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+
"example": "./examples",
19+
"lib": "./lib",
20+
"test": "./test"
21+
},
22+
"scripts": {},
23+
"homepage": "https://github.com/stdlib-js/stdlib",
24+
"repository": {
25+
"type": "git",
26+
"url": "git://github.com/stdlib-js/stdlib.git"
27+
},
28+
"bugs": {
29+
"url": "https://github.com/stdlib-js/stdlib/issues"
30+
},
31+
"dependencies": {},
32+
"devDependencies": {},
33+
"engines": {
34+
"node": ">=0.10.0",
35+
"npm": ">2.7.0"
36+
},
37+
"os": [
38+
"aix",
39+
"darwin",
40+
"freebsd",
41+
"linux",
42+
"macos",
43+
"openbsd",
44+
"sunos",
45+
"win32",
46+
"windows"
47+
],
48+
"keywords": [
49+
"stdlib",
50+
"standard",
51+
"library",
52+
"std",
53+
"lib",
54+
"simulation",
55+
"simulate",
56+
"iterator",
57+
"iterable",
58+
"iteration",
59+
"iter"
60+
]
61+
}

‎lib/node_modules/@stdlib/simulate/iter/test/test.js

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2019 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 tape = require( 'tape' );
24+
var objectKeys = require( '@stdlib/utils/keys' );
25+
var rand = require( './../lib' );
26+
27+
28+
// TESTS //
29+
30+
tape( 'main export is an object', function test( t ) {
31+
t.ok( true, __filename );
32+
t.equal( typeof rand, 'object', 'main export is an object' );
33+
t.end();
34+
});
35+
36+
tape( 'the exported object contains key-value pairs', function test( t ) {
37+
var keys = objectKeys( rand );
38+
t.equal( keys.length > 0, true, 'has keys' );
39+
t.end();
40+
});

0 commit comments

Comments
 (0)