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

@websaam/sdk-ts-starter

v1.0.6

Published

# Getting started

Downloads

9

Readme

A boilerplate to start create a Typescript SDK

Getting started

npx @websaam/sdk-ts-starter my-ts-sdk

Installation

  1. Run yarn

  2. Change your configs in esbuild-config.js

  3. Change your package name in package.json, rename @websaam/sdk-ts-starter to anything you want

HTML

devHtml: Listens to Typescript file changes from src, and output to src_build_from_ts, which is also being listend and built to ./build/web/index.js. Finally, run a live server on localhost:3000

Open tests/html/html-test.html to edit

<script src="/build/web/index.js"></script>
<script>
    console.log("ExampleSDK:", ExampleSDK);
    ExampleSDK.foo();
</script>

React

devReact: Listens to Typescript file changes from src, and output to src_build_from_ts, which is also being listend and built to ./build/node/index.js. Finally, run React app on localhost:3000


// 1. Download React
yarn getReact

// 2. Build the SDK for both client/node, and publish locally using yalc
yarn build

// 3. Go to the React app and link the local published sdk (change the name of the package name `@websaam/sdk-ts-starter` to something you desired)
yarn linkReact

// 4. In the App.js
import * as ExampleSDK from '@websaam/sdk-ts-starter';
ExampleSDK.hello();