dsfx3d / readable-to-string

The correct way of collecting a stream into a string. Works with both Text and Buffer mode streams unlike most of the popular npm packages

Repository from Github https://github.comdsfx3d/readable-to-stringRepository from Github https://github.comdsfx3d/readable-to-string

workspace

A pnpm workspace boilerplate for Typescript projects.

Features

  • Managed with pnpm, ensuring efficient package management.
  • ESLint configuration extending eslint-config-dsfx3d.
  • Sample module foo exported in the main index.

Workspace Structure

The workspace is structured as follows:

  • Main packages are located in the packages/ directory.
  • Additional components can be added in the components/ directory.
  • Packages inside test directories are excluded.

Installation

To set up the workspace:

pnpm bootstrap

Scripts

  • bootstrap: Update packages and install Husky hooks.

Dependencies

  • Development:
    • @commitlint/cli
    • @commitlint/config-conventional
    • eslint
    • eslint-config-dsfx3d
    • husky
    • prettier
    • typescript

packageName

npm version npm downloads bundle Codecov

This is my package description.

Usage

Install package:

# npm
npm install packageName

# yarn
yarn add packageName

# pnpm
pnpm install packageName

Import:

// ESM
import {} from "packageName";

// CommonJS
const {} = require("packageName");

Development

  • Clone this repository
  • Install latest LTS version of Node.js
  • Enable Corepack using corepack enable
  • Install dependencies using pnpm install
  • Run interactive tests using pnpm dev

License

Made with đź’›

Published under MIT License.

About

The correct way of collecting a stream into a string. Works with both Text and Buffer mode streams unlike most of the popular npm packages

License:MIT License


Languages

Language:TypeScript 90.4%Language:Shell 5.6%Language:JavaScript 4.0%