0.0.4

.github/workflows/CI.yml

@@ -162,59 +162,6 @@ jobs:
  name: bindings-${{ matrix.settings.target }}
  path: ${{ env.APP_NAME }}.*.node
  if-no-files-found: error
- # build-freebsd:
- # runs-on: macos-12
- # name: Build FreeBSD
- # steps:
- # - uses: actions/checkout@v3
- # with:
- # submodules: true
- # - name: Build
- # id: build
- # uses: vmactions/freebsd-vm@v0
- # env:
- # DEBUG: napi:*
- # RUSTUP_HOME: /usr/local/rustup
- # CARGO_HOME: /usr/local/cargo
- # RUSTUP_IO_THREADS: 1
- # with:
- # envs: DEBUG RUSTUP_HOME CARGO_HOME RUSTUP_IO_THREADS
- # usesh: true
- # mem: 3000
- # prepare: |
- # pkg install -y -f curl node libnghttp2 llvm cmake # Install the llvm package to fix the libclang error
- # curl -qL https://www.npmjs.com/install.sh | sh
- # npm install --location=global --ignore-scripts yarn
- # curl https://sh.rustup.rs -sSf --output rustup.sh
- # sh rustup.sh -y --profile minimal --default-toolchain beta
- # rustup component add rustfmt
- # export PATH="/usr/local/cargo/bin:$PATH"
- # echo "~~~~ rustc --version ~~~~"
- # rustc --version
- # echo "~~~~ node -v ~~~~"
- # node -v
- # echo "~~~~ yarn --version ~~~~"
- # yarn --version
- # run: |
- # export PATH="/usr/local/cargo/bin:$PATH"
- # pwd
- # ls -lah
- # whoami
- # env
- # freebsd-version
- # yarn install
- # yarn build
- # strip -x *.node
- # yarn test
- # rm -rf node_modules
- # rm -rf target
- # rm -rf .yarn/cache
- # - name: Upload artifact
- # uses: actions/upload-artifact@v3
- # with:
- # name: bindings-freebsd
- # path: ${{ env.APP_NAME }}.*.node
- # if-no-files-found: error
  test-macOS-windows-binding:
  name: Test bindings on ${{ matrix.settings.target }} - node@${{ matrix.node }}
  needs:

README.md

@@ -1,6 +1,6 @@
 # @neplex/vectorizer
 
-A simple Node.js library to convert raster images into svg using [VTracer](https://github.com/visioncortex/vtracer).
+A simple Node.js library to convert raster images into svg using [VTracer](https://github.com/visioncortex/vtracer), with time complexity of `O(n)`.
 
 ## Installation
 

example/index.mjs

@@ -16,6 +16,10 @@ const config = {
  maxIterations: 2,
 };
 
+const begin = performance.now();
 const result = await vectorize(src, config);
+const end = performance.now();
+
+console.log(`[Anime Girl Vectorization] Time: ${(end - begin).toFixed(2)}ms`);
 
 await writeFile('./example/result.svg', result);

index.d.ts

@@ -22,16 +22,27 @@ export const enum PathSimplifyMode {
  Spline = 2
 }
 export interface Config {
+ /** True color image or binary image (black and white) */
  colorMode: ColorMode
+ /** Hierarchial clustering or non-stacked. Only applicable to color images. */
  hierarchical: Hierarchical
+ /** Discard patches smaller than X pixels in size (cleaner) */
  filterSpeckle: number
+ /** The number of significant bits to use in an RGB channel (more accurate) */
  colorPrecision: number
+ /** The color difference between gradient layers (less layers) */
  layerDifference: number
+ /** Curve fitting mode */
  mode: PathSimplifyMode
+ /** Minimum momentary angle (degree) to be considered a corner (smoother) */
  cornerThreshold: number
+ /** Perform iterative subdivide smooth until all segments are shorter than this length */
  lengthThreshold: number
+ /** The maximum number of iterations to perform */
  maxIterations: number
+ /** Minimum angle displacement (degree) to splice a spline (less accurate) */
  spliceThreshold: number
+ /** Number of decimal places to use in path string */
  pathPrecision?: number
 }
 export interface RawDataConfig {

npm/android-arm-eabi/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@neplex/vectorizer-android-arm-eabi",
- "version": "0.0.0",
+ "version": "0.0.4",
  "os": [
  "android"
  ],

npm/android-arm64/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@neplex/vectorizer-android-arm64",
- "version": "0.0.0",
+ "version": "0.0.4",
  "os": [
  "android"
  ],

npm/darwin-arm64/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@neplex/vectorizer-darwin-arm64",
- "version": "0.0.0",
+ "version": "0.0.4",
  "os": [
  "darwin"
  ],

npm/darwin-universal/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@neplex/vectorizer-darwin-universal",
- "version": "0.0.0",
+ "version": "0.0.4",
  "os": [
  "darwin"
  ],

npm/darwin-x64/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@neplex/vectorizer-darwin-x64",
- "version": "0.0.0",
+ "version": "0.0.4",
  "os": [
  "darwin"
  ],