This package defines Typescript types (.d.ts) for the upcoming WebGPU standard.
Use this package to augment the ambient "dom" type definitions with the new definitions for WebGPU.
This repo also generates typedoc docs here: https://gpuweb.github.io/types
See the TypeScript handbook.
- npm:
npm install --save-dev @webgpu/types - yarn:
yarn add --dev @webgpu/types - pnpm:
pnpm add -D @webgpu/types
If you are on TypeScript < 5.1, you will also need to install @types/dom-webcodecs
as a sibling dependency. The version you need depends on the TypeScript version;
see the tests for examples.
Since this package is outside DefinitelyTyped, the dependency won't be picked up automatically. There are several ways to add a additional TypeScript type definition dependencies to your TypeScript project:
In tsconfig.json:
{
// ...
"compilerOptions": {
// ...
"types": ["@webgpu/types"]
}
}Or you can use typeRoots:
{
// ...
"compilerOptions": {
// ...
"typeRoots": ["./node_modules/@webgpu/types", "./node_modules/@types"]
}
}This may work better if your toolchain doesn't read tsconfig.json.
/// <reference types="@webgpu/types" />If you use Webpack and the options above aren't sufficient (this has not been verified),
you may need the following in webpack.config.js:
"types": ["@webgpu/types"]Please contribute a PR to add instructions for other setups or improve existing instructions. :)
- Make sure the submodule is checked out:
git submodule update --init - Pull
gpuwebchanges:pushd gpuweb && git checkout main && git pull && popd - Install dependencies:
npm ci - Bug workaround: paste the
copies.bscontents in place of its include inindex.bs(generator doesn't support includes). - Generate
generated/index.d.ts:npm run generate - Open a diff between
generated/index.d.tsanddist/index.d.ts. The generated file is tracked by Git so you can see what has changed. Update the latter according to changes from the former. Note thegenerated/anddist/files are not the same. See below for intentional differences. - Format the result:
npm run format
Most or all of these should be fixed in the generator over time.
Arraychanged toIterablefor WebIDLsequences in argument positions.anychanged toobjectfor WebIDLobject.| SharedArrayBufferadded for[AllowShared] BufferSource.
The following differences are TODO: should be changed in the final result.
- Deprecated items should be removed.
The following differences will remain.
onuncapturederrorstrongly typed.getContextdefinitions.GPUExtent3DStrictandGPUOrigin2DStrict.
(only for people who have npm publish access)
- One line cmd to copy-n-paste (for ssh git user, and you'd better know what you are doing, if it failed at certain steps, you might need to clean up git tags before trying again)
git checkout main && git pull [email protected]:gpuweb/types.git main && git submodule update --init && npm version patch && git push [email protected]:gpuweb/types.git main --tags && npm publish
- Separate steps (better for publishing for the first time)
- Make sure you are in the upstream repo, not your forked one. And make sure you are synced to latest commit intended for publish
git checkout maingit pull https://github.com/gpuweb/types.git main- (If you are using HTTPS regularly. You can use remote names like
origin, just make sure you are referring to the right repo)
- (If you are using HTTPS regularly. You can use remote names like
git submodule update --init
- Create the version tag and commit, and push
npm version patchgit push https://github.com/gpuweb/types.git main --tags
- publish the package
npm publish --otp=<code>- Replace
<code>with the one-time password from your authenticator, since two-factors authentication is required to publish. - If you are doing for the first time, you will do
npm adduserfirst and it will guide you through adding the npm account.
- Replace
- Make sure you are in the upstream repo, not your forked one. And make sure you are synced to latest commit intended for publish
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent