@bedrock-apis/env-types 1.0.0-beta
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 +21 -0
- package/README.md +42 -0
- package/lib.d.ts +6837 -0
- package/package.json +22 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Bedrock APIs
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# env-types
|
|
2
|
+
|
|
3
|
+
TypeScript type definitions for environment-specific QuickJS engine that doesn't strictly follow standard ES versioning. This package provides a curated set of global types and methods tailored for non-standard runtimes, ensuring better development experience and type safety for your projects.
|
|
4
|
+
|
|
5
|
+
> **Note:** This package is currently in **beta**. Contributions, bug reports, and suggestions are highly appreciated! Check out our [GitHub repository](https://github.com/bedrock-apis/env-types) for more information.
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
- Provides environment-specific TypeScript type definitions for non-standard engines.
|
|
10
|
+
- Covers selective feature support across different engine versions.
|
|
11
|
+
- Includes global classes, methods, and properties specific to each environment.
|
|
12
|
+
- Helps catch runtime errors early by providing accurate type safety.
|
|
13
|
+
- Designed to supplement and compare against TypeScript's global types.
|
|
14
|
+
|
|
15
|
+
# Installation
|
|
16
|
+
Install the package as a development dependency, and add it to the known types in your `tsconfig.json`:
|
|
17
|
+
```json
|
|
18
|
+
{
|
|
19
|
+
"compilerOptions": {
|
|
20
|
+
"noLib": true,
|
|
21
|
+
"types": ["@bedrock-apis/env-typescript"],
|
|
22
|
+
// ...
|
|
23
|
+
}
|
|
24
|
+
// ...
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Plan
|
|
29
|
+
|
|
30
|
+
- Generate a basic set of methods and properties for each global class.
|
|
31
|
+
- Compare and extend these definitions against TypeScript’s standard global types.
|
|
32
|
+
- Continuously update with contributions and new engine features.
|
|
33
|
+
|
|
34
|
+
## Contributing
|
|
35
|
+
|
|
36
|
+
This package is in **beta**, and we welcome contributions from the community. You can help by:
|
|
37
|
+
|
|
38
|
+
* Adding missing type definitions.
|
|
39
|
+
* Fixing inconsistencies between types and engine environment.
|
|
40
|
+
* Suggesting new features or improvements.
|
|
41
|
+
|
|
42
|
+
Please visit our [GitHub repository](https://github.com/bedrock-apis/env-types) to submit issues or pull requests.
|