JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 12
  • Score
    100M100P100Q73508F
  • License MIT

A library for reading and writing DBPF files.

Package Exports

  • dbpf
  • dbpf/dist/dbpf.js
  • dbpf/dist/dbpf.web.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (dbpf) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

DBPF.js a dbpf file reader in TypeScript

This is a simple library for reading DBPF files in TypeScript/JavaScript. Currently, it only parses the header and index, but a plugin system is planned to allow for reading and handling of the actual data.

Building and Usage

This library can be used in both the browser and node.js. Currently, no releases are available, however building is simple:

git clone https://github.com/anonhostpi/DBPF.js
cd DBPF.js

# Install dependencies
npm install

# Build the library
npm run build

# Launch test environment
npm run test
# - sets up a local static server at http://localhost:8080 and opens a browser to a test page for interactive testing

Both the build and test build will use webpack to bundle the library for the browser.

The entry points are as follows:

Built files:

  • dist/dbpf.js - The library for use in node.js
  • dist/dbpf.web.js - The library for use in the browser
  • test/index.html and test/test.web.js - The test environment for the browser

Source files:

  • src/dbpf.ts - The main library
  • src/test.ts - The test environment used by npm run test

DBPF.js test environment