@cloudflare/workers-types 3.17.0 → 3.19.0
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 +17 -2
- package/index.d.ts +962 -371
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -1,7 +1,17 @@
|
|
|
1
1
|
# Cloudflare Workers Types
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
:stop_sign: This repository was for `@cloudflare/workers-types` versions ≤ 3 and is no longer maintained.
|
|
4
|
+
|
|
5
|
+
Since version 4, types are automatically generated from and in the [`workerd`](https://github.com/cloudflare/workerd) repository.
|
|
6
|
+
|
|
7
|
+
Find the [new `README` here](https://github.com/cloudflare/workerd/tree/main/npm/workers-types) and the [new auto-generation scripts here](https://github.com/cloudflare/workerd/tree/main/types).
|
|
8
|
+
|
|
9
|
+
Please raise issues with type definitions [in the `workerd` repository](https://github.com/cloudflare/workerd/issues/new/choose), tagging `@cloudflare/workers-types` in your report.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
<details>
|
|
14
|
+
<summary>Legacy Documentation</summary>
|
|
5
15
|
|
|
6
16
|
## Install
|
|
7
17
|
|
|
@@ -13,6 +23,9 @@ yarn add -D @cloudflare/workers-types
|
|
|
13
23
|
|
|
14
24
|
## Usage
|
|
15
25
|
|
|
26
|
+
> :warning: If you're upgrading from version 2, make sure to remove `webworker` from the `lib` array in your
|
|
27
|
+
> `tsconfig.json`. These types are now included in `@cloudflare/workers-types`.
|
|
28
|
+
|
|
16
29
|
The following is a minimal `tsconfig.json` for use alongside this package:
|
|
17
30
|
|
|
18
31
|
**`tsconfig.json`**
|
|
@@ -74,3 +87,5 @@ headings correspond to JSDoc sections for members:
|
|
|
74
87
|
- `#### Returns`: contents will be copied as-is to the `@returns` tag
|
|
75
88
|
- `#### Examples`: fenced code blocks with the language set to `js`, `ts`, `javascript` or `typescript` will be copied
|
|
76
89
|
to `@example` tags
|
|
90
|
+
|
|
91
|
+
</details>
|