• Stars
    star
    185
  • Rank 201,311 (Top 5 %)
  • Language Vue
  • License
    MIT License
  • Created 9 months ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Display APIs compatibility across different JavaScript runtimes

unjs/runtime-compat

license

Display APIs compatibility across different JavaScript runtimes. The data is automatically generated using the runtime tests from mdn-bcd-collector and published in the MDN browser-compat-data format.

View the results or re-use the data.

Warning

The current data is not 100% accurate and is auto generated. Please open an issue if you have spotted any inconsistencies.

About the data

The data is generated using the tests from the mdn-bcd-collector project. These were originally created for MDN's browser-compat-data, which is the data that powers sites such as the MDN Web Docs and CanIUse. These tests were designed to run in a browser environment, so we use a slightly modified version of the test harness to allow them to run in non-browser runtimes.

The runner code is is slightly different for each runtime, because of the variety of different ways they are designed to be invoked. Broadly they fall into two groups - the ones that can be run directly from the CLI, and others that are invoked via an HTTP request. For these we use the project's own development server, and then use start-server-and-test to run the server and make a request for a function that runs the test file.

The output of each of these is a data.json file in each runtime directory, containing the results of the tests. If you want to check why a specific test failed, you should start by inspecting the contents of this file as it contains the code and error message for each test.

Another script then processes these files, combines them with the metadata about each API from the browser-compat-data project, and then writes the data as a JSON file to the runtime-compat-data directory. This is then published to npm as the runtime-compat-data module.

The tests can be run locally, but the actual data generation process is run on GitHub Actions, which opens a PR if there are any changes.

Running tests locally

Install + Prepare

  • Clone this repository
  • Install latest LTS version of Node.js
  • Install Bun
  • Install Fastly CLI
  • Install Wasmer
  • Download LLRT and place executable in PATH
  • Enable Corepack using corepack enable
  • Install dependencies using pnpm install

Generate the data

To generate data for all runtimes, run pnpm run generate in the project source.

To generate data for an individual runtime, navigate to generator/runtimes/<runtime> and run pnpm start.

Limitations

The actual tests are designed to run in browsers, so there may be inconsistencies. For the same reason, they also do not test for any WinterCG-specific features.

Several supported runtimes are normally used via a hosted service. These are tested locally using a development library or server, which may differ from the production environment.

Some runtimes may define a particular API object or method, but as a stub or noop rather than as an actual feature. In most cases this will be shown as being supported. Usually these feature make no sense outside a browser environment, but have been implemented to allow code to run cross-platform.

The tests were created for browsers so they make some assumptions about their environment. We try to work around as many as we can, but there are still false negatives. For example, most of the Request and URL tests assume that they can create relative URLs. These don't work in most non-browser runtimes by design, because there is no location.href for them to be relative to. Currently this means that a lot of these tests are reporting as failed, even though the runtimes support most of these features.

The tests are only run against the latest stable version of each runtime, so the data only shows whether the feature is supported now. In most cases these runtimes are updated regularly, so this should not be a problem. The exception is Node.js, which is often run using old versions. For this you may like to compare the data with the MDN docs, which include support details for old versions of Node.

Notes for specific runtimes

Deno

Deno is tested using the deno CLI, which has different support than the Deno Deploy. That service has more limitations and often has features added on a a different schedule.

Vercel Edge Runtime

Tests are run against the open source Edge Runtime library (identified with the key edge-light), which run in Node. This is designed to be identical to the Vercel Edge Runtime (which is based on workerd), but there may be differences. This is particularly likely to be the case when a feature is reported as unsupported on Edge Runtime but supported by workerd.

Netlify

Tests are run using the Netlify CLI, which uses the Deno CLI. While this does use settings designed to mimic the production version, there may be differences. We have manually skipped some of the features (such as WebGPU) that falsely reported as supported, there there may still be some false results.

License

Published under the MIT license. Made by community πŸ’›

More Repositories

1

consola

🐨 Elegant Console Logger for Node.js and Browser
TypeScript
5,424
star
2

nitro

Next Generation Server Toolkit. Create web servers with everything you need and deploy them wherever you prefer.
TypeScript
4,941
star
3

magic-regexp

A compiled-away, type-safe, readable RegExp alternative
TypeScript
3,531
star
4

ofetch

😱 A better fetch API. Works on node, browser and workers.
TypeScript
3,106
star
5

h3

⚑️ Minimal H(TTP) framework built for high performance and portability
TypeScript
2,910
star
6

unplugin

Unified plugin system for Vite, Rollup, Webpack, esbuild, rolldown, and more
TypeScript
2,799
star
7

magicast

πŸ§€ Programmatically modify JavaScript and TypeScript source codes with a simplified, elegant and familiar syntax powered by recast and babel.
TypeScript
2,112
star
8

webpackbar

Elegant ProgressBar and Profiler for Webpack 3 , 4 and 5
TypeScript
2,041
star
9

unbuild

πŸ“¦ An unified javascript build system
TypeScript
1,989
star
10

unstorage

πŸ’Ύ Unstorage provides an async Key-Value storage API with conventional features like multi driver mounting, watching and working with metadata, dozens of built-in drivers and a tiny core.
TypeScript
1,406
star
11

fontaine

Automatic font fallback based on font metrics
TypeScript
1,388
star
12

jiti

Runtime Typescript and ESM support for Node.js
TypeScript
1,284
star
13

ipx

πŸ–ΌοΈ High performance, secure and easy-to-use image optimizer.
TypeScript
1,070
star
14

destr

πŸš€ Faster, secure and convenient alternative for JSON.parse
TypeScript
894
star
15

ufo

πŸ”— URL utils for humans
TypeScript
888
star
16

untun

πŸš‡ Tunnel your local HTTP(s) server to the world! powered by Cloudflare Quick Tunnels.
TypeScript
853
star
17

defu

🌊 Assign default properties recursively
TypeScript
828
star
18

changelogen

πŸ’… Beautiful Changelogs using Conventional Commits
TypeScript
745
star
19

hookable

πŸͺ Awaitable Hooks
TypeScript
593
star
20

citty

πŸŒ† Elegant CLI Builder
TypeScript
533
star
21

unhead

Unhead is the any-framework document head manager built for performance and delightful developer experience.
TypeScript
501
star
22

ohash

Super fast hashing library based on murmurhash3 written in Vanilla JS
JavaScript
460
star
23

unimport

Unified utils for auto importing APIs in modules.
TypeScript
433
star
24

uqr

Generate QR Code universally, in any runtime, to ANSI, Unicode or SVG.
TypeScript
401
star
25

mlly

🀝 Common ECMAScript module utils
TypeScript
398
star
26

ungh

πŸ™ Unlimited access to github API
TypeScript
383
star
27

nypm

🌈 Unified Package Manager for Node.js and Bun
TypeScript
379
star
28

std-env

Runtime Agnostic JS utils
TypeScript
373
star
29

untyped

Generate types and markdown from a config object.
TypeScript
372
star
30

c12

βš™οΈ Smart Configuration Loader
TypeScript
367
star
31

listhen

πŸ‘‚ Elegant HTTP Listener
TypeScript
363
star
32

giget

✨ Download templates and git repositories with pleasure!
TypeScript
353
star
33

radix3

🌳 Lightweight and fast router for JavaScript based on Radix Tree
TypeScript
348
star
34

unctx

🍦 Composables in vanilla JS
TypeScript
348
star
35

pathe

πŸ›£οΈ Drop-in replacement of the Node.js's path module module that ensures paths are normalized
TypeScript
332
star
36

mkdist

Lightweight file-to-file transpiler.
TypeScript
304
star
37

unpdf

πŸ“„ Utilities to work with PDFs in Node.js, browser and workers
TypeScript
284
star
38

unenv

πŸ•ŠοΈ Convert javaScript code to be runtime agnostic
TypeScript
282
star
39

scule

🧡 String Case Utils
TypeScript
268
star
40

knitwork

Utilities to generate JavaScript code.
TypeScript
224
star
41

rc9

Read/Write config couldn't be easier!
TypeScript
216
star
42

get-port-please

πŸ”Œ Get an available open port
TypeScript
204
star
43

lmify

πŸ€™ Install NPM dependencies programmatically (please switch to unjs/nypm)
JavaScript
200
star
44

theme-colors

🎨 Easily generate color shades for themes
TypeScript
185
star
45

perfect-debounce

Debounce promise-returning & async functions.
TypeScript
171
star
46

pkg-types

Node.js utilities and TypeScript definitions for package.json and tsconfig.json
TypeScript
170
star
47

unkit

πŸ“™ UnJS standard library
TypeScript
168
star
48

crossws

πŸ”Œ Cross-platform WebSocket Servers for Node.js, Deno, Bun and Cloudflare Workers.
TypeScript
167
star
49

uncrypto

Single API for Web Crypto API and Crypto Subtle working in Node.js, Browsers and other runtimes
TypeScript
154
star
50

httpxy

πŸ”€ A Full-Featured HTTP and WebSocket Proxy for Node.js
TypeScript
149
star
51

serve-placeholder

β™‘ Smart placeholder for missing assets
TypeScript
144
star
52

node-fetch-native

better fetch for Node.js. Works on any JavaScript runtime!
TypeScript
141
star
53

template

πŸ“‹ UnJS Project Starter Template
TypeScript
136
star
54

unwasm

πŸ‡Ό WebAssembly tools for JavaScript
JavaScript
128
star
55

website

UnJS website Content and Design!
Vue
116
star
56

db0

πŸ“š Lightweight SQL Connector
TypeScript
111
star
57

mongoz

πŸ₯­ Zero Config MongoDB Server
TypeScript
102
star
58

automd

πŸ€– Automated markdown maintainer
TypeScript
100
star
59

cookie-es

πŸͺ Cookie Serializer and Deserializer
TypeScript
97
star
60

redirect-ssl

Connect/Express middleware to enforce https using is-https
TypeScript
96
star
61

jimp-compact

✏️ Lightweight version of Jimp -- An image processing library written entirely in JavaScript for Node.js
TypeScript
91
star
62

nanotar

πŸ“Ό Tiny and fast tar utils for any JavaScript runtime!
TypeScript
80
star
63

undocs

Minimal Documentation theme and CLI for shared usage across UnJS projects.
Vue
76
star
64

mdbox

⬇ Just simple markdown utils
JavaScript
58
star
65

items-promise

Bare minimum async methods using promises
JavaScript
51
star
66

image-meta

Detect image type and size using pure javascript.
TypeScript
51
star
67

nitro-deploys

Nitro Deployments Testing
TypeScript
45
star
68

compat-flags

🌴 Gradual feature flags.
TypeScript
45
star
69

confbox

Compact and high quality YAML, TOML, JSONC and JSON5 parsers
TypeScript
38
star
70

ezpass

Dead simple password protection middleware
TypeScript
33
star
71

workbox-cdn

Workbox Unofficial CDN and standalone NPM package.
Shell
30
star
72

rollup-plugin-node-deno

Convert NodeJS to Deno compatible code with rollup
TypeScript
29
star
73

externality

TypeScript
28
star
74

create-require

Polyfill for Node.js module.createRequire (<= v12.2.0)
JavaScript
27
star
75

requrl

Grab full URL from request.
TypeScript
26
star
76

is-https

Check if the given request is HTTPS
TypeScript
26
star
77

bundle-runner

Run webpack bundles in Node.js with optional VM sandboxing
TypeScript
21
star
78

eslint-config

πŸ“– Shared ESLint config for unjs repositories
JavaScript
20
star
79

fs-memo

Easy persisted memo object for Node.js
TypeScript
18
star
80

nitro-starter

Nitro starter template
TypeScript
16
star
81

nitro-preset-starter

TypeScript
15
star
82

governance

UnJS Governance Notes
14
star
83

community

UnJS Community Notes
14
star
84

renovate-config

13
star
85

.github

Community Health Files
8
star
86

unjs.github.io

HTML
4
star
87

html-validate-es

TypeScript
4
star