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

transform-json-api

v1.1.12

Published

This module provides the ability to safely transform responses of different API requests using configuration alone.

Downloads

4

Readme

Transform JSON API

This module provides the ability to safely transform responses of different API requests using configuration alone.

install

npm i transform-json-api

usage

fetch(url, options, mapping, baseMapping = null)

  • url - The URL of the API endpoint
  • options - A fetch options object that is compatible with node-fetch.
  • mapping - A mapping object.
  • baseMapping - An object that holds the starting point path for the mapping. Default is "root".

mapping object

This object holds the configurations to tranform the API response to the desired object.

  1. Keys: String. represents a key name in the tranformed result. Currently dynamic key names are not supported.
  2. Values, One of two options:
  3. String. hold the path to the desired value in the API response.
  4. Object. A mapping operation for array items.

mapping operations

This object represent a predefined complex operation of mapping. It's structure:

[operation(args)]
  • operation - The name of the operation
  • args - Required argument for the operation

See also: Supported mapping operations

path

A path always start from "root" and represents the pointer to the response object. Supported syntax:

  • .string - e.g. "root.key"
  • [int] - e.g. "root[0]"
  • ['string'] - e.g. "root['key']"

Examples

Suppose API POST https://example.com/echo responsds with the provided JSON body. So this code:

const TransformJsonAPI = require('transform-json-api');

const url = "https://example.com/echo";
const options = {
  method: "POST",
  body: {
    data: {
      test: true,
      items: [
        {index: 1, name: "item 1"},
        {index: 2, name: "item 2"}
      ]
    }
  }
}
const mapping = {
    "item_names": "root[map(root.name)]",
}

const transorm = TransformJsonAPI.fetch(url, options, mapping, "root.data.items")
// transorm ->  ["item 1", "item 2"]

format()

format(input:string|object, [output:string|object])

A simple string template function based on named or indexed arguments base on this string-template package

const greeting = format("Hello {name}, you have {count} unread messages", {
    name: "Robert",
    count: 12
})
// greeting -> "Hello Robert, you have 12 unread messages"

Excepts Objects as well

parameters()

parameters([input:string|object])

returns keys from a string template

const keys = parameters("Hello {name}, you have {count} unread messages");
// keys -> ["name", "count"]

Alternative with multiple arguments and not just with strings

const greeting = "Hello {name}, you have {count} unread messages";
const publishedAt = {"package_{id}": "Published at: {date}"};

const [greetingKeys, publishedAtKeys] = parameters(greeting, publishedAt);

// greetingKeys -> ["name", "count"]
// publishedAtKeys -> ["id", "date"]

License

This package is licensed under the MIT license.