Remove (a)sync entries and add asset entry with an example

ustclug-dev · Nov 20, 2023 · 058d4b7 · 058d4b7
1 parent c544650
commit 058d4b7
Show file tree

Hide file tree

Showing 14 changed files with 1,340 additions and 26 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,138 @@
+## Node
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+## wasm-pack
+
 /target
 **/*.rs.bk
 # wasm-pack prefers (generated in the project boilerplate) to ignore the lock file.
@@ -7,5 +142,7 @@ bin/
 pkg/
 wasm-pack.log
 
+## Others
+
 # Dev
 .idea/
diff --git a/asset.d.ts b/asset.d.ts
@@ -0,0 +1,6 @@
+import type { InitOutput } from './pkg/index.js'
+
+export type * from './pkg/index.js'
+
+declare const BrotliDecWasmPromise: Promise<InitOutput>
+export default BrotliDecWasmPromise
diff --git a/sync.js → asset.js b/sync.js → asset.js
@@ -1,6 +1,6 @@
-import { initSync } from './pkg/index.js'
+import init from './pkg/index.js'
 import wasm from './pkg/index_bg.wasm'
 
 export * from './pkg/index.js'
 
-export default initSync(wasm)
+export default init(wasm)
diff --git a/async.d.ts b/async.d.ts
diff --git a/async.js b/async.js
diff --git a/example/webpack-asset/index.html b/example/webpack-asset/index.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>webpack asset example</title>
+    <link rel="stylesheet" href="https://unpkg.com/mvp.css" />
+  </head>
+  <body>
+    <h1>webpack asset example</h1>
+    <p id="status"></p>
+    <script src="dist/index.js"></script>
+  </body>
+</html>
diff --git a/example/webpack-asset/index.js b/example/webpack-asset/index.js
@@ -0,0 +1,11 @@
+import brotliDecWasmPromise from 'brotli-dec-wasm/asset'
+
+async function main() {
+  const brotliDecWasm = await brotliDecWasmPromise
+  window.brotliDecWasm = brotliDecWasm
+}
+
+main().then(() => {
+  console.log('init ok')
+  document.getElementById('status').innerText = 'init ok'
+})
diff --git a/example/webpack-asset/package.json b/example/webpack-asset/package.json
@@ -0,0 +1,22 @@
+{
+  "name": "webpack-asset",
+  "version": "1.0.0",
+  "description": "",
+  "private": true,
+  "scripts": {
+    "build": "webpack --config webpack.config.cjs",
+    "dev": "http-server -c-1 ."
+  },
+  "keywords": [],
+  "author": "myl7 <myl@myl.moe> (https://myl.moe)",
+  "license": "MIT OR Apache-2.0",
+  "type": "module",
+  "dependencies": {
+    "brotli-dec-wasm": "link:../.."
+  },
+  "devDependencies": {
+    "http-server": "^14.1.1",
+    "webpack": "^5.89.0",
+    "webpack-cli": "^5.1.4"
+  }
+}