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

@d1g1t/type-api

v2.1.0

Published

Typescript enabled API library

Downloads

4

Readme

Typescript enabled API library

Greenkeeper badge

Build Status NPM version Standard Version styled with prettier Conventional Commits

Consumption of published library:

yarn add type-api or npm install type-api

Webpack

import {RestApi} from 'type-api'

/**
 * Define rest api
 */
class PostApi extends RestApi {
    baseUrl = 'https://jsonplaceholder.typicode.com'
    endpoint = '/posts'
}

/**
 * Initialize api
 */
export const postApi = new PostApi()

// Get one by ID
try {
    const response = postApi.findById(1)

    console.log(response)
} catch (error) {
    console.error(error)
}

// Create entity
try {
    const postData =   {
        "userId": 1,
        "title": "New user",
        "body": "Some content"
    },
    const response = postApi.create(postData)

    console.log(response)
} catch (error) {
    console.error(error)
}

// Update entity
try {
    const postData =   {
        "userId": 1,
        "title": "New user",
        "body": "Some content"
    },
    const response = postApi.update(1, postData)

    console.log(response)
} catch (error) {
    console.error(error)
}

Available methods

Rest API

  • findById(id) : GET - retrieve one record as object
  • findAll() : GET - retrieve all records as list
  • findOne({name: 'some name'}) : GET - retrieve one record from list of response results
  • find({limit: 3}) : GET - retrieve records as list and generate query string from object
  • create({name: 'Some Name'}) : POST - submit object for creation
  • update(1, {name: 'Some Name'}) : PUT - submit object for update

Base API

  • get('custom')
  • post('custom', postData)
  • put('custom', putData)
  • patch('custom', patchData)