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

@squiz/xaccel-data-fetcher

v1.13.1

Published

A helper function to grab data from endpoints.

Downloads

504

Readme

Data Fetcher

Description

A utility for fetching an array of child assets from a root node using the Matrix Content API

See example.ts for working example implementation

import { MatrixApiAdapter, DataFetcher } from @squiz/xaccel-data-fetcher;

const matrixAdapter = new MatrixApiAdapter(rootNodeId, assetType, resultLimit, sortByOptions.name, sortOrderOptions.asc, customMap);

(async () => {
    const getData = await DataFetcher(matrixAdapter, apiEndpoint, apiKey);
    console.log(getData);
})();

MatrixApiAdapter

Class constructor that returns and transforms Matrix data

Usage

import { MatrixApiAdapter } from @squiz/xaccel-data-fetcher;

const matrixAdapter = new MatrixApiAdapter(rootNodeId, assetType, resultLimit, sortByOptions.name, sortOrderOptions.asc, customMap);

required arguments

  • rootNodeId { Number = 4243 }
  • assetType { String or Array for multiple = 'page_standard' or ['news_item','page_standard'] or even ['page_standard'] will be ok too }

optional arguments

  • resultLimit { Number = 20 }
  • sortBy { String of the following value }
    • id
    • type
    • version
    • name
    • shortName
    • statusId
    • createdDate
    • updatedDate
    • publishedDate
    • statusChangedDate
  • sortOrder { String of the following value }
    • asc
    • desc
  • customMap { Callback function to transform the raw data returned by the API }

DataFetcher

A function that takes an adapter, API endpoint URL and API key

Usage

import { DataFetcher } from @squiz/xaccel-data-fetcher;

(async () => {
    const getData = await DataFetcher(matrixAdapter, apiEndpoint, apiKey);
})();

required arguments

  • matrixAdapter { Matrix adapter }
  • apiEndPoint { String }

Local Development

npm run start will run the example.ts file on Node and console log the returned data

For simple local development set up a .env file with the following variables and/or edit the example.ts file to your liking

CONTENT_API=" "

CONTENT_API_KEY=" "