Skip to content

Commit 8228188

Browse files
author
Jake Champion
committed
docs: update CompressionStream and DecompressionStream docs to include examples and simplify the types
1 parent 551f2a0 commit 8228188

File tree

248 files changed

+23059
-2103
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

248 files changed

+23059
-2103
lines changed

package-lock.json

Lines changed: 4088 additions & 1163 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@
4141
"eslint": "^8.28.0",
4242
"get-bin-path": "^7.2.1",
4343
"patch-package": "^6.5.0",
44-
"tsd": "^0.24.1",
44+
"tsd": "^0.25.0",
4545
"typedoc": "^0.23",
4646
"typedoc-plugin-mdn-links": "^2.0.0",
47-
"typedoc-plugin-versions": "^0.2.1",
47+
"typedoc-plugin-versions": "^0.2.2",
4848
"typescript": "^4.9"
4949
},
5050
"dependencies": {

patches/typedoc-plugin-versions+0.2.1.patch

Lines changed: 0 additions & 13 deletions
This file was deleted.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
diff --git a/node_modules/typedoc-plugin-versions/src/etc/utils.js b/node_modules/typedoc-plugin-versions/src/etc/utils.js
2+
index db6b2cb..e92c4e8 100644
3+
--- a/node_modules/typedoc-plugin-versions/src/etc/utils.js
4+
+++ b/node_modules/typedoc-plugin-versions/src/etc/utils.js
5+
@@ -235,9 +235,7 @@ function makeJsKeys(metadata) {
6+
const alias = metadata.stable ? 'stable' : 'dev';
7+
const keys = [
8+
alias,
9+
- ...metadata.versions // add the major.minor versions
10+
- .map((v) => getMinorVersion(v))
11+
- .filter((v, i, s) => s.indexOf(v) === i),
12+
+ ...metadata.versions,
13+
];
14+
if (alias !== 'dev' && metadata.dev) {
15+
keys.push('dev');
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
:root {
2+
--light-hl-0: #008000;
3+
--dark-hl-0: #6A9955;
4+
--light-hl-1: #800000;
5+
--dark-hl-1: #808080;
6+
--light-hl-2: #800000;
7+
--dark-hl-2: #569CD6;
8+
--light-hl-3: #FF0000;
9+
--dark-hl-3: #9CDCFE;
10+
--light-hl-4: #000000;
11+
--dark-hl-4: #D4D4D4;
12+
--light-hl-5: #A31515;
13+
--dark-hl-5: #CE9178;
14+
--light-hl-6: #0000FF;
15+
--dark-hl-6: #569CD6;
16+
--light-hl-7: #795E26;
17+
--dark-hl-7: #DCDCAA;
18+
--light-hl-8: #001080;
19+
--dark-hl-8: #9CDCFE;
20+
--light-hl-9: #0070C1;
21+
--dark-hl-9: #4FC1FF;
22+
--light-hl-10: #AF00DB;
23+
--dark-hl-10: #C586C0;
24+
--light-hl-11: #000000FF;
25+
--dark-hl-11: #D4D4D4;
26+
--light-code-background: #FFFFFF;
27+
--dark-code-background: #1E1E1E;
28+
}
29+
30+
@media (prefers-color-scheme: light) { :root {
31+
--hl-0: var(--light-hl-0);
32+
--hl-1: var(--light-hl-1);
33+
--hl-2: var(--light-hl-2);
34+
--hl-3: var(--light-hl-3);
35+
--hl-4: var(--light-hl-4);
36+
--hl-5: var(--light-hl-5);
37+
--hl-6: var(--light-hl-6);
38+
--hl-7: var(--light-hl-7);
39+
--hl-8: var(--light-hl-8);
40+
--hl-9: var(--light-hl-9);
41+
--hl-10: var(--light-hl-10);
42+
--hl-11: var(--light-hl-11);
43+
--code-background: var(--light-code-background);
44+
} }
45+
46+
@media (prefers-color-scheme: dark) { :root {
47+
--hl-0: var(--dark-hl-0);
48+
--hl-1: var(--dark-hl-1);
49+
--hl-2: var(--dark-hl-2);
50+
--hl-3: var(--dark-hl-3);
51+
--hl-4: var(--dark-hl-4);
52+
--hl-5: var(--dark-hl-5);
53+
--hl-6: var(--dark-hl-6);
54+
--hl-7: var(--dark-hl-7);
55+
--hl-8: var(--dark-hl-8);
56+
--hl-9: var(--dark-hl-9);
57+
--hl-10: var(--dark-hl-10);
58+
--hl-11: var(--dark-hl-11);
59+
--code-background: var(--dark-code-background);
60+
} }
61+
62+
:root[data-theme='light'] {
63+
--hl-0: var(--light-hl-0);
64+
--hl-1: var(--light-hl-1);
65+
--hl-2: var(--light-hl-2);
66+
--hl-3: var(--light-hl-3);
67+
--hl-4: var(--light-hl-4);
68+
--hl-5: var(--light-hl-5);
69+
--hl-6: var(--light-hl-6);
70+
--hl-7: var(--light-hl-7);
71+
--hl-8: var(--light-hl-8);
72+
--hl-9: var(--light-hl-9);
73+
--hl-10: var(--light-hl-10);
74+
--hl-11: var(--light-hl-11);
75+
--code-background: var(--light-code-background);
76+
}
77+
78+
:root[data-theme='dark'] {
79+
--hl-0: var(--dark-hl-0);
80+
--hl-1: var(--dark-hl-1);
81+
--hl-2: var(--dark-hl-2);
82+
--hl-3: var(--dark-hl-3);
83+
--hl-4: var(--dark-hl-4);
84+
--hl-5: var(--dark-hl-5);
85+
--hl-6: var(--dark-hl-6);
86+
--hl-7: var(--dark-hl-7);
87+
--hl-8: var(--dark-hl-8);
88+
--hl-9: var(--dark-hl-9);
89+
--hl-10: var(--dark-hl-10);
90+
--hl-11: var(--dark-hl-11);
91+
--code-background: var(--dark-code-background);
92+
}
93+
94+
.hl-0 { color: var(--hl-0); }
95+
.hl-1 { color: var(--hl-1); }
96+
.hl-2 { color: var(--hl-2); }
97+
.hl-3 { color: var(--hl-3); }
98+
.hl-4 { color: var(--hl-4); }
99+
.hl-5 { color: var(--hl-5); }
100+
.hl-6 { color: var(--hl-6); }
101+
.hl-7 { color: var(--hl-7); }
102+
.hl-8 { color: var(--hl-8); }
103+
.hl-9 { color: var(--hl-9); }
104+
.hl-10 { color: var(--hl-10); }
105+
.hl-11 { color: var(--hl-11); }
106+
pre, code { background: var(--code-background); }

reference-docs/v0.5.11/assets/main.js

Lines changed: 54 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

reference-docs/v0.5.11/assets/search.js

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)