@usco/stl-parser NPM

usco-stl-parser

Fast and efficient stl format parser

Optimized for speed (webworkers)
And low memory consumption (streams)
works in Node.js & browser
there is currently no support for backpressure

Install

npm i @usco/stl-parser

Usage

  import makeParsedStream from '@usco/stl-parser'

  //for binary stl files
  fs.createReadStream('./someFile.stl', { encoding: null})
    .pipe(makeParsedStream({concat: true}))
    .on('data', function (parsed) {
      console.log('parsed', parsed)
      //DO what you want with the data
    })

  //for ascii stl files
  fs.createReadStream('./someFile.stl')
    .pipe(makeParsedStream({concat: true}))
    .on('data', function (parsed) {
      console.log('parsed', parsed)
      //DO what you want with the data
    })

API

returns a node.js stream containing geometric (positions & normals) data in TypedArrays (Float32Array)
useable both on Node.js & client side

works something like this

raw data stream => raw chunks => | worker | => parsed chunks => concat

only exports a single function:

makeParsedStream(options)

options.useWorker use web workers (browser only) defaults to true in browser
options.concat (default: true) when set to true, stream outputs a single value with all combined data , ie the whole mesh data: this is the default and it what you usually want to use