https://github.com/jacobbubu/pull-stream-types

https://github.com/jacobbubu/pull-stream-types

Last synced: 14 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/jacobbubu/pull-stream-types
• Owner: jacobbubu
• License: mit
• Created: 2020-01-27T02:45:53.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-05T05:38:42.000Z (about 2 years ago)
• Last Synced: 2024-12-27T03:33:34.554Z (about 1 month ago)
• Language: TypeScript
• Homepage:
• Size: 1.2 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

        
# @jacobbubu/pull-stream-types

[![Build Status](https://travis-ci.org/jacobbubu/pull-stream-types.svg)](https://travis-ci.org/jacobbubu/pull-stream-types)

[![npm](https://img.shields.io/npm/v/@jacobbubu/pull-stream-types.svg)](https://www.npmjs.com/package/@jacobbubu/pull-stream-types/)

> Yet another [pull-stream](https://github.com/pull-stream/pull-stream) typescript declaration file.

## Intro.

Although [Michael de Wit](https://github.com/mjwwit) has provided a typescript declaration file for [pull-stream](https://github.com/pull-stream/pull-stream), in order to facilitate some type-wise modifications, I still extract the original one out and use it independently.

## Usage

```bash

npm install pull-stream -S

npm install @jacobbubu/pull-stream-types -D

```

Then add a module definition into your `compilerOptions` in `tsconfig.json`. That may look like:

```json

{

  "compilerOptions": {

    "baseUrl": ".",

    "paths": {

      "pull-stream": ["node_modules/@jacobbubu/pull-stream-types"]

    }

  }

}

```

It works for `tsc`, `ts-node` and `ts-node-dev`.

## Test

A test file(`test/pull-stream-test.ts`) has been provided to verify the correctness of the declaration file.

You can `npm run build:watch` for debugging.