Skip to content

Commit f7e56f5

Browse files
committed
Initial scaffold for minimum common api
1 parent 39e170a commit f7e56f5

File tree

3 files changed

+103
-0
lines changed

3 files changed

+103
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
index.html

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
To build the spec locally first install bikeshed:
2+
3+
```sh
4+
pip3 install bikeshed && bikeshed update
5+
```
6+
7+
Then to build the spec (index.bs) into HTML (index.html), run one of the below
8+
commands:
9+
10+
```sh
11+
bikeshed spec # build once
12+
13+
# or
14+
15+
bikeshed watch # rebuild on changes
16+
```

index.bs

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
<pre class='metadata'>
2+
Title: Minimum Common Web Platform API
3+
Shortname: common-web-platform-api
4+
Status: w3c/UD
5+
URL: https://owpacg.github.io/common
6+
Repository: https://github.com/owpacg/common
7+
Editor: James M Snell, Cloudflare https://cloudflare.com/, [email protected]
8+
Abstract: Minimum Common Web Platform API for Non-Browser EcmaScript-based runtimes.
9+
Markup Shorthands: markdown yes
10+
</pre>
11+
<pre class=link-defaults>
12+
spec:url; type:interface; text:URL
13+
spec:html; type:attribute; for:WorkerGlobalScope; text:navigator
14+
</pre>
15+
16+
Introduction {#intro}
17+
=====================
18+
19+
*This section is non-normative.*
20+
21+
TBD
22+
23+
Use Cases {#use-cases}
24+
======================
25+
26+
*This section is non-normative.*
27+
28+
TBD
29+
30+
Terminology {#terminology}
31+
==========================
32+
33+
TBD
34+
35+
Common API Index {#index}
36+
=========================
37+
38+
All runtime environments purporting to conform to this specification SHALL fully implement each of
39+
the following Web Platform APIs in accordance to their normative standard definitions as
40+
referenced. Where any conforming runtime environment chooses (either by necessity or otherwise) to
41+
diverge from a normative requirement of the specification, clear explanations of such divergence
42+
MUST be made readily available in documentation.
43+
44+
Interfaces:
45+
46+
* {{AbortController}}
47+
* {{AbortSignal}}
48+
* {{ByteLengthQueuingStrategy}}
49+
* <code class="idl"><a data-link-type="idl" href="https://wicg.github.io/compression/#compression-stream">CompressionStream</a></code>
50+
* {{CountQueuingStrategy}}
51+
* {{Crypto}}
52+
* {{CryptoKey}}
53+
* <code class="idl"><a data-link-type="idl" href="https://wicg.github.io/compression/#decompression-stream">DecompressionStream</a></code>
54+
* {{DOMException}}
55+
* {{Event}}
56+
* {{EventTarget}}
57+
* {{ReadableByteStreamController}}
58+
* {{ReadableStream}}
59+
* {{ReadableStreamBYOBReader}}
60+
* {{ReadableStreamBYOBRequest}}
61+
* {{ReadableStreamDefaultController}}
62+
* {{ReadableStreamDefaultReader}}
63+
* {{SubtleCrypto}}
64+
* {{TextDecoder}}
65+
* {{TextDecoderStream}}
66+
* {{TextEncoder}}
67+
* {{TextEncoderStream}}
68+
* {{TransformStream}}
69+
* {{TransformStreamDefaultController}}
70+
* {{URL}}
71+
* <code class="idl"><a data-link-type="idl" href="https://wicg.github.io/urlpattern/#urlpattern-class">URLPattern</a></code>
72+
* {{URLSearchParams}}
73+
* {{WritableStream}}
74+
* {{WritableStreamDefaultController}}
75+
76+
Global methods / properties:
77+
78+
* <code class="idl"><a data-link-type="idl" href="https://tc39.es/ecma262/multipage/global-object.html#sec-globalthis">globalThis</a></code>
79+
* globalThis.{{atob()}}
80+
* globalThis.{{btoa()}}
81+
* globalThis.{{console}}
82+
* globalThis.{{navigator}}.{{userAgent}}
83+
* globalThis.{{queueMicrotask()}}
84+
* globalThis.{{setTimeout()}} / globalThis.{{clearTimeout()}}
85+
* globalThis.{{setInterval()}} / globalThis.{{clearInterval()}}
86+
* globalThis.{{structuredClone()}}

0 commit comments

Comments
 (0)