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

@jacob-schroder/api-types

v1.1.37

Published

Shared type collection for the backend API.

Downloads

8

Readme

API Types package for YOUANDX 3.0 Microservices.

Consuming the types as a client

To use these types in API consumer clients, first install the package using npm i -D @jacob-schroder/api-types. If the package is already installed and needs updating, use npm update.

From here, you can use any type directly, eg. import { IAddSpeakerArgs, ICreateRes } from '@jacob-schroder/api-types';.

Adding and updating to types

To add new types, please use a corresponding type declaration file within the /types directory.

Eg. for types on the "product" entity, please use /types/product.

If you create a new entity type file, please make sure to re-export it in the api.ts file in the root directory.

! Notice the /types/shared directory, meant for types shared across multiple entities.

Pushing / publishing new work

! Before pushing to NPM, please make sure you are logged into NPM on an owner account. Use npm login to do so. If you require access, contact the package owner (Mark).

Modifications can be published by running npm run push. This command does three thing;

  • It compiles the project using tsc.
  • It increments the version number in the package.json by 0.1.
  • It publishes the package itself to npm.