@rocketman-streamkit/types 1.0.2 → 1.0.3
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 +11 -0
- package/addon.d.ts +3 -25
- package/package.json +2 -1
- package/tsconfig.json +10 -0
package/README.md
CHANGED
|
@@ -71,6 +71,17 @@ Alternatively, reference the package types field directly:
|
|
|
71
71
|
|
|
72
72
|
Do **not** add `@types/node` — addon workers are not Node.js processes.
|
|
73
73
|
|
|
74
|
+
Do **not** include `"DOM"` in `compilerOptions.lib` — sandbox globals such as `URL`, `console`, and `status` intentionally replace browser typings.
|
|
75
|
+
|
|
76
|
+
The npm package ships `tsconfig.json`; you can extend it in your addon project:
|
|
77
|
+
|
|
78
|
+
```json
|
|
79
|
+
{
|
|
80
|
+
"extends": "./node_modules/@rocketman-streamkit/types/tsconfig.json",
|
|
81
|
+
"include": ["./**/*.ts"]
|
|
82
|
+
}
|
|
83
|
+
```
|
|
84
|
+
|
|
74
85
|
---
|
|
75
86
|
|
|
76
87
|
## Examples
|
package/addon.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
// AUTO-GENERATED — do not edit manually
|
|
2
2
|
// Source: backend/addons/list/integrations/index.ts -> GenerateContext()
|
|
3
|
+
// Typecheck with lib: ["ES2020"] only (no DOM) — see tsconfig.json in this folder.
|
|
3
4
|
|
|
4
5
|
declare global {
|
|
5
6
|
type URLSearchParamsInit = | string
|
|
@@ -8,7 +9,7 @@ declare global {
|
|
|
8
9
|
| ReadonlyArray<[string, string]>
|
|
9
10
|
| URLSearchParams;
|
|
10
11
|
|
|
11
|
-
|
|
12
|
+
class URLSearchParams {
|
|
12
13
|
constructor(init?: URLSearchParamsInit);
|
|
13
14
|
static from(native: URLSearchParams): URLSearchParams;
|
|
14
15
|
append(name: string, value: string): void;
|
|
@@ -27,26 +28,7 @@ declare global {
|
|
|
27
28
|
size: number;
|
|
28
29
|
}
|
|
29
30
|
|
|
30
|
-
|
|
31
|
-
constructor(init?: URLSearchParamsInit);
|
|
32
|
-
static from(native: URLSearchParams): URLSearchParams;
|
|
33
|
-
append(name: string, value: string): void;
|
|
34
|
-
delete(name: string, value?: string): void;
|
|
35
|
-
get(name: string): string | null;
|
|
36
|
-
getAll(name: string): string[];
|
|
37
|
-
has(name: string, value?: string): boolean;
|
|
38
|
-
set(name: string, value: string): void;
|
|
39
|
-
sort(): void;
|
|
40
|
-
toString(): string;
|
|
41
|
-
keys(): IterableIterator<string>;
|
|
42
|
-
values(): IterableIterator<string>;
|
|
43
|
-
entries(): IterableIterator<[string, string]>;
|
|
44
|
-
forEach(callback: (value: string, key: string, parent: URLSearchParams) => void, thisArg: unknown): void;
|
|
45
|
-
[Symbol.iterator](): IterableIterator<[string, string]>;
|
|
46
|
-
size: number;
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
declare class UrlCustom {
|
|
31
|
+
class UrlCustom {
|
|
50
32
|
constructor(url: string | UrlCustom, base?: string | UrlCustom);
|
|
51
33
|
static canParse(url: string, base?: string | UrlCustom): boolean;
|
|
52
34
|
static parse(url: string, base?: string | UrlCustom): UrlCustom | null;
|
|
@@ -79,10 +61,6 @@ declare global {
|
|
|
79
61
|
Record<Exclude<AddonConfigLang, 'en'>, string>
|
|
80
62
|
>;
|
|
81
63
|
|
|
82
|
-
type DashboardLocalizedString = | string
|
|
83
|
-
| [LangData, ...(string | number)[]]
|
|
84
|
-
| DashboardLocalizedText;
|
|
85
|
-
|
|
86
64
|
type DashboardLocalizedString = | string
|
|
87
65
|
| [LangData, ...(string | number)[]]
|
|
88
66
|
| DashboardLocalizedText;
|
package/package.json
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rocketman-streamkit/types",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "TypeScript declarations for the StreamKit+ integration addon sandbox API",
|
|
5
5
|
"types": "addon.d.ts",
|
|
6
6
|
"files": [
|
|
7
7
|
"addon.d.ts",
|
|
8
|
+
"tsconfig.json",
|
|
8
9
|
"README.md"
|
|
9
10
|
],
|
|
10
11
|
"keywords": [
|