npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@basd/encoder

v0.0.6

Published

Provides a convenient way to define models and their associated fields for encoding and decoding various data formats.

Downloads

8

Readme

Encoder

npm pipeline license downloads

Gitlab Github Twitter Discord

A highly extensible encoding library built on top of the @basd/codex package. It provides a convenient way to define models and their associated fields allowing users to easily encode and decode data structures using different encoding schemes such as Base58 and foreign fields.

Features

  • Custom Field Types: Supports different field types including base58 and foreign.
  • Flexible Models: Define and use models easily to work with complex data structures.
  • Encoding and Decoding: Provides simple and efficient encoding and decoding capabilities.
  • Foreign Field Encoding: Seamlessly encode and decode foreign fields linked to other models.
  • Bs58 Encoding: Out-of-the-box support for Base58 encoding and decoding.

Installation

Install the package with:

npm install @basd/encoder

Usage

First, import the Encoder library.

import Encoder from '@basd/encoder'

or

const Encoder = require('@basd/encoder')

Use the Encoder:

// Define models in the constructor
const encoder = new Encoder({ someType: { someField: 'string' }})

// Define a model by adding it
encoder.addModel('myModelType', { someField: 'string' })
// or
encoder.addModel('myModelType', { fields: { someField: 'string' }})

// Encode the data
const encodedData = encoder.encode('myModelType', data)

// Decode the data
const decodedData = encoder.decode('myModelType', encodedData)

Advanced Usage

Here's an example of using a foreign field to reference another model:

const models = {
  user: { name: 'string', age: 'number' },
  post: { title: 'string', body: 'string', author: 'user' },
}
const encoder = new Encoder(models, opts)
let data = { name: 'Alice', age: 33 }
let user = encoder.create('user', data)
let content = { title: 'Hello', body: 'World', author: user }
let post = encoder.create('post', content)

let encoded = encoder.encode('post', post)
let decoded = encoder.decode('post', encoded)

Documentation

Classes

Base58Field

This class extends the string field type and provides encoding and decoding capabilities specific to the Base58 format.

EncoderForeignField

The EncoderForeignField class extends the Codex's foreign field type to provide specific encoding and decoding functionality for foreign types.

EncoderModel

The EncoderModel class provides methods for encoding and decoding a complete model by iterating through the defined fields.

Encoder

The Encoder class is the main interface for working with models, defining encoding, and decoding methods based on the schema and options provided.

Tests

In order to run the test suite, simply clone the repository and install its dependencies:

git clone https://gitlab.com/frenware/utils/encoder.git
cd encoder
npm install

To run the tests:

npm test

Contributing

Thank you! Please see our contributing guidelines for details.

Donations

If you find this project useful and want to help support further development, please send us some coin. We greatly appreciate any and all contributions. Thank you!

Bitcoin (BTC):

1JUb1yNFH6wjGekRUW6Dfgyg4J4h6wKKdF

Monero (XMR):

46uV2fMZT3EWkBrGUgszJCcbqFqEvqrB4bZBJwsbx7yA8e2WBakXzJSUK8aqT4GoqERzbg4oKT2SiPeCgjzVH6VpSQ5y7KQ

License

@basd/encoder is MIT licensed.