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

@heapstream/heapstream

v1.0.0

Published

Explore the API documentation for [Heapstream.com](//heapstream.com)! ## Authentication API authentication is done using Basic Authentication [wikipedia](https://en.wikipedia.org/wiki/Basic_access_authentication) [RFC7617](https://datatracker.ietf.org/

Downloads

15

Readme

Heapstream TypeScript SDK 1.0.0

Welcome to the Heapstream SDK documentation. This guide will help you get started with integrating and using the Heapstream SDK in your project.

Versions

  • API version: 1.0
  • SDK version: 1.0.0

About the API

Explore the API documentation for Heapstream.com! ## Authentication API authentication is done using Basic Authentication wikipedia RFC7617. For username you should use the id of the ApiKey. For password you should use the password of the ApiKey.

Table of Contents

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: TypeScript >= 4.8.4

Installation

To get started with the SDK, we recommend installing using npm:

npm install @heapstream/heapstream

Authentication

Basic Authentication

The Heapstream API uses Basic Authentication.

You need to provide your username and password when initializing the SDK.

Setting the Username and Password

When you initialize the SDK, you can set the username and password as follows:

const sdk = new Heapstream({ username: 'YOUR_USERNAME', password: 'YOUR_PASSWORD' });

If you need to set or update the username and password after initializing the SDK, you can use:

const sdk = new Heapstream();
sdk.username = 'YOUR_USERNAME';
sdk.password = 'YOUR_PASSWORD';

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

const heapstream = new Heapstream({ timeout: 10000 });

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

import { Heapstream } from '@heapstream/heapstream';

(async () => {
  const heapstream = new Heapstream({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
  });

  const { data } = await heapstream.project.listProjects();

  console.log(data);
})();

Services

The SDK provides various services to interact with the API.

| Name | | :------------------------------------------------------------------- | | ProjectService | | DirectUploadService | | PlayerService | | StatsService | | VideoService | | AudioTrackService | | PosterService | | TextTrackService | | WatermarkService | | WebhookService |

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

| Name | Description | | :--------------------------------------------------------------------------- | :---------- | | ProjectList | | | ProjectCreate | | | Project | | | ProjectEdit | | | DirectUploadStart | | | DirectUploadResponse | | | DirectUploadListResponse | | | DirectUploadCompleteArgs | | | PartIdResponse | | | PlayerList | | | PlayerCreate | | | Player | | | PlayerEdit | | | EngagementStats | | | PerformanceStatsResponse | | | VideoList | | | ListVideosStatus | | | VideoFetch | | | Video | | | VideoEdit | | | PresetList | | | AudioTrackList | | | AudioTrackCreate | | | AudioTrack | | | AudioTrackEdit | | | PosterList | | | MultipartFile | | | Poster | | | PosterEdit | | | TextTrackList | | | TextTrackCreate | | | TextTrack | | | TextTrackGenerate | | | TextTrackEdit | | | WatermarkList | | | WatermarkCreate | | | Watermark | | | WebhookList | | | WebhookCreate | | | Webhook | | | UploadMetadata | | | Asset | | | AssetError | | | DirectUploadPart | | | EngagementStatsRow | | | PerformanceStatsRow | | | Pagination | | | Preset | | | AutoCaption | |

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.