@kykungz/vizz-engine v1.0.1

vizz-engine

Model generator and crawler engine of Vizz. Chromium is required for running a puppeteer instance.

Usage

Basic

import VizzEngine, { FileSystemStorage } from '@kykungz/vizz-engine'

// Memory Storage (Default)
const vizzEngine = new VizzEngine()

// File System Storage
const vizzStorage = new FileSystemStorage('/images')
const vizzEngine = new VizzEngine(vizzStorage)

Model Generation

// Generate model
await vizzEngine.generate('https://facebook.com')

// Generate model with callback
await vizzEngine.generate('https://facebook.com', {
  onNode: (vizzNode, count, length) => {
    console.log(...)
  },
})

Image Retrieval

// Get target id from vizzNode
const id = vizzNode.id

// Retrieve image associated to the id
const bufferImage = await vizzEngine.getImage('https://facebook.com', id)