Code Monkey home page Code Monkey logo

node-puzzle's Introduction

node-puzzle

npm GitHub

Node.js 生成滑块验证码的拼图和背景图。

安装

npm install node-puzzle
yarn add node-puzzle
pnpm add node-puzzle

使用

import fs from 'fs';
import createPuzzle from 'node-puzzle';

// 第一个参数是图片地址,支持本地路径和远程地址
// 第二个参数是处理后的背景图和拼图写入流(如写入到路径)
createPuzzle('./sunflower.jpg', {
  bg: fs.createWriteStream('bg.jpg'),
  puzzle: fs.createWriteStream('puzzle.png')
}).then((res) => {
  // 背景图和拼图处理完成后,返回中包含拼图 x 轴和 y 轴偏移值
  console.log(res); // { x: 229, y: 0 }
});

输入图片:

sunflower.jpg

origin

▼▼▼

生成背景图和拼图保存到本地:

bg.jpg

bg

puzzle.png

puzzle

▼▼▼

异步返回 { x: 229, y: 0 }

API

type Output = {
  bg: WriteStream;
  puzzle: WriteStream;
};

type Options = {
  // 拼图
  borderWidth?: number; // 描边宽度。默认 1
  borderColor?: string; // 描边颜色。默认 rgba(255,255,255,0.7)
  fillColor?: string; // 填充颜色。默认 rgba(255,255,255,0.7)
  width?: number; // 宽度。默认 60
  height?: number; // 高度。默认 60
  x?: number; // x 轴偏移值,如果不传内部随机生成。
  y?: number; // y 轴偏移值,如果不传内部随机生成。
  margin?: number; // 上下左右留白。默认 2
  equalHeight?: boolean; // 等高。默认 true

  // 背景图
  bgWidth?: number; // 背景图宽度。默认 图片宽度
  bgHeight?: number; // 背景图高度。默认 图片高度
  bgOffset?: [number, number]; // 背景图偏移值。 默认 [0,0]

  // 导出配置
  bgImageType?: 'png' | 'jpeg'; // 背景图导出类型。默认 jpeg
  quality?: number; // 导出图片质量,仅作用于 `jepg` 图片。默认 80 。
  pngOptions?: Parameters<typeof PImage.encodePNGToStream>[2]; // 导出 png 图片配置,仅作用于 `png` 图片。
};

type createPuzzle = (
  input: string | Buffer,
  output: Output,
  options: Options = {}
) => Promise<{ x: number; y: number }>;

常见问题

控制台警告信息 “can't project the same paths 1 [ 'l', t { x: 44, y: 16 } ] t { x: 44, y: 16 } t { x: 44, y: 16 }”

参考:joshmarinacci/node-pureimage#98 (comment)

可以忽略该警告。

感谢

node-puzzle's People

Contributors

caijf avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

node-puzzle's Issues

提示createPuzzle is not a function

按照说明的方法使用,却提示createPuzzle is not a function

import { fileURLToPath } from 'url';
import { dirname } from 'path';
import fs from 'fs';
import path from 'path';
import createPuzzle from 'node-puzzle';

const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename);

createPuzzle(path.join(__dirname, 'sunflower.jpg'), {
  bg: fs.createWriteStream(path.join(__dirname, 'bg.jpg')),
  puzzle: fs.createWriteStream(path.join(__dirname, 'puzzle.png'))
}).then((res) => {
  console.log(res);
});
/usr/local/bin/node ./index.mjs
Uncaught TypeError TypeError: createPuzzle is not a function
    at <anonymous> (/Users/****/****/puzzle/index.mjs:10:1)
    at run (internal/modules/esm/module_job:194:25)
    --- await ---
    at processTicksAndRejections (internal/process/task_queues:95:5)
    --- await ---
    at runMainESM (internal/modules/run_main:60:21)
    at executeUserEntryPoint (internal/modules/run_main:83:5)
    at <anonymous> (internal/main/run_main_module:23:47)
index.mjs:10
Process exited with code 1

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.