Skip to content

Commit a573204

Browse files
piyxsh31piyxsh31
committed
feat: add constants/wasm and constants/wasm/page-size
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 7f83de8 commit a573204

16 files changed

Lines changed: 686 additions & 1 deletion

File tree

‎lib/node_modules/@stdlib/constants/wasm/README.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 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+
# Constants
22+
23+
> WebAssembly constants.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var constants = require( '@stdlib/constants/wasm' );
31+
```
32+
33+
#### constants
34+
35+
WebAssembly constants.
36+
37+
```javascript
38+
var ns = constants;
39+
// returns {...}
40+
```
41+
42+
<!-- <toc pattern="*"> -->
43+
44+
<div class="namespace-toc">
45+
46+
- <span class="signature">[`PAGE_SIZE`][@stdlib/constants/wasm/page-size]</span><span class="delimiter">: </span><span class="description">WebAssembly memory page size (in bytes).</span>
47+
48+
</div>
49+
50+
<!-- </toc> -->
51+
52+
</section>
53+
54+
<!-- /.usage -->
55+
56+
<section class="examples">
57+
58+
## Examples
59+
60+
<!-- TODO: better examples -->
61+
62+
<!-- eslint no-undef: "error" -->
63+
64+
```javascript
65+
var objectKeys = require( '@stdlib/utils/keys' );
66+
var constants = require( '@stdlib/constants/wasm' );
67+
68+
console.log( objectKeys( constants ) );
69+
```
70+
71+
</section>
72+
73+
<!-- /.examples -->
74+
75+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
76+
77+
<section class="related">
78+
79+
</section>
80+
81+
<!-- /.related -->
82+
83+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
84+
85+
<section class="links">
86+
87+
<!-- <toc-links> -->
88+
89+
[@stdlib/constants/wasm/page-size]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/wasm/page-size
90+
91+
<!-- </toc-links> -->
92+
93+
</section>
94+
95+
<!-- /.links -->

‎lib/node_modules/@stdlib/constants/wasm/docs/types/index.d.ts‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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: 4.1
20+
21+
/* eslint-disable max-lines */
22+
23+
import PAGE_SIZE = require( '@stdlib/constants/wasm/page-size' );
24+
25+
/**
26+
* Interface describing the `wasm` namespace.
27+
*/
28+
interface Namespace {
29+
/**
30+
* WebAssembly memory page size (in bytes).
31+
*
32+
* @example
33+
* var n = ns.PAGE_SIZE;
34+
* // returns 65536
35+
*/
36+
PAGE_SIZE: typeof PAGE_SIZE;
37+
}
38+
39+
/**
40+
* WebAssembly constants.
41+
*/
42+
declare var ns: Namespace;
43+
44+
45+
// EXPORTS //
46+
47+
export = ns;

‎lib/node_modules/@stdlib/constants/wasm/docs/types/tests.ts‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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+
/* eslint-disable @typescript-eslint/no-unused-expressions */
20+
21+
import ns = require( './index' );
22+
23+
24+
// TESTS //
25+
26+
// The exported value is the expected interface...
27+
{
28+
ns; // $ExpectType Namespace
29+
}

‎lib/node_modules/@stdlib/constants/wasm/examples/index.js‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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/constants/wasm/lib/index.js‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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 PAGE_SIZE
41+
* @memberof ns
42+
* @readonly
43+
* @constant
44+
* @type {number}
45+
* @see {@link module:@stdlib/constants/wasm/page-size}
46+
*/
47+
setReadOnly( ns, 'PAGE_SIZE', require( '@stdlib/constants/wasm/page-size' ) );
48+
49+
50+
// EXPORTS //
51+
52+
module.exports = ns;

‎lib/node_modules/@stdlib/constants/wasm/package.json‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
{
2+
"name": "@stdlib/constants/wasm",
3+
"version": "0.0.0",
4+
"description": "WebAssembly constants.",
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/index.js",
17+
"directories": {
18+
"doc": "./docs",
19+
"example": "./examples",
20+
"lib": "./lib",
21+
"test": "./test"
22+
},
23+
"types": "./docs/types",
24+
"scripts": {},
25+
"homepage": "https://github.com/stdlib-js/stdlib",
26+
"repository": {
27+
"type": "git",
28+
"url": "git://github.com/stdlib-js/stdlib.git"
29+
},
30+
"bugs": {
31+
"url": "https://github.com/stdlib-js/stdlib/issues"
32+
},
33+
"dependencies": {},
34+
"devDependencies": {},
35+
"engines": {
36+
"node": ">=0.10.0",
37+
"npm": ">2.7.0"
38+
},
39+
"os": [
40+
"aix",
41+
"darwin",
42+
"freebsd",
43+
"linux",
44+
"macos",
45+
"openbsd",
46+
"sunos",
47+
"win32",
48+
"windows"
49+
],
50+
"keywords": [
51+
"stdlib",
52+
"stdtypes",
53+
"constants",
54+
"const",
55+
"webassembly",
56+
"wasm",
57+
"namespace",
58+
"ns"
59+
]
60+
}

0 commit comments

Comments
 (0)