@bedrock-apis/env-types 1.0.0-beta.4 → 1.0.0-beta.6
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/README.md +28 -7
- package/lib.d.ts +4471 -3858
- package/package.json +5 -3
package/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# env-types
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@bedrock-apis/env-types)
|
|
4
|
+
|
|
3
5
|
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
6
|
|
|
5
7
|
> **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.
|
|
@@ -12,23 +14,42 @@ TypeScript type definitions for environment-specific QuickJS engine that doesn't
|
|
|
12
14
|
- Helps catch runtime errors early by providing accurate type safety.
|
|
13
15
|
- Designed to supplement and compare against TypeScript's global types.
|
|
14
16
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
+
## Installation
|
|
18
|
+
|
|
19
|
+
Install the package as a development dependency using your preferred package manager:
|
|
20
|
+
|
|
21
|
+
### npm
|
|
22
|
+
```bash
|
|
23
|
+
npm install --save-dev @bedrock-apis/env-types
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
### pnpm
|
|
27
|
+
```bash
|
|
28
|
+
pnpm add -D @bedrock-apis/env-types
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### yarn
|
|
32
|
+
```bash
|
|
33
|
+
yarn add --dev @bedrock-apis/env-types
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Configuration
|
|
37
|
+
|
|
38
|
+
Add the package to the `types` field in your `tsconfig.json`:
|
|
39
|
+
|
|
17
40
|
```json
|
|
18
41
|
{
|
|
19
42
|
"compilerOptions": {
|
|
20
43
|
"noLib": true,
|
|
21
|
-
"types": ["@bedrock-apis/env-types"]
|
|
22
|
-
// ...
|
|
44
|
+
"types": ["@bedrock-apis/env-types"]
|
|
23
45
|
}
|
|
24
|
-
// ...
|
|
25
46
|
}
|
|
26
47
|
```
|
|
27
48
|
|
|
28
|
-
## Plan
|
|
49
|
+
## Development Plan
|
|
29
50
|
|
|
30
51
|
- Generate a basic set of methods and properties for each global class.
|
|
31
|
-
- Compare and extend these definitions against TypeScript
|
|
52
|
+
- Compare and extend these definitions against TypeScript's standard global types.
|
|
32
53
|
- Continuously update with help of contributions.
|
|
33
54
|
|
|
34
55
|
## Contributing
|