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

open-watch-ckan

v1.0.2

Published

JavaScript Library For Interfacing with CKAN APIs

Downloads

342

Readme

open-watch-ckan

Node.js CI bundlesize issues

open-watch-ckan is a JavaScript Library for interacting with CKAN APIs.

Official CKAN Documentation

Please refer to the Official CKAN Documentation for specific information about the API

Installing

npm install open-watch-ckan

Using The Library

const CKAN = require('open-watch-ckan');

CKAN Endpoints - Predefined Objects and Custom Creation

  • CKAN_Endpoints are axios instances configured to point to a specific base URL of a CKAN API.
  • CKAN_Endpoints are passed into data-fetching functions to make requests.

Predefined Endpoints

const {
  AB_CKAN,
  BC_CKAN,
  OT_CKAN,
  CAN_CKAN,
} = CKAN.endpoints;

Custom Endpoints

  • If your target API is not included in the default CKAN.endpoints object, you can create your own CKAN_Endpoint object.
const customCKAN: CKAN_Endpoint = CKAN.createEndpoint('https://data.example.ckan.api/3');

Making Requests

  • Making requests is the same with both predefined and custom CKAN_Endpoints:
// All Datasets
const albertaDatasets: DatasetList = await CKAN.getAllDatasets(AB_CKAN);
const customDatasets: DatasetList = await CKAN.getAllDatasets(customCKAN);

// Specific Dataset
const specificAlbertaData: Dataset = await CKAN.getDatasetFromId(AB_CKAN, '<dataset_id>');
const specificCustomData: Dataset = await CKAN.getDatasetFromId(customCKAN, '<dataset_id>');

// Recently Changed Datasets
const albertaRecentData: DatasetList = await CKAN.getAllDatasets(AB_CKAN);
const customRecentData: DatasetList  = await CKAN.getAllDatasets(customCKAN);

// Tag Names
const albertaTagNames: TagNamesList = await CKAN.getAllTagNames(AB_CKAN);
const customTagNames: TagNamesList = await CKAN.getAllTagNames(customCKAN);

For convinience, these are the type defitions for the different responses from CKAN API calls

type CKAN_Endpoint = AxiosInstance

interface DatasetList {
  help: string,
  success: boolean,
  result: string[]
};

interface Dataset {
  help: string,
  success: boolean,
  result: object
};

interface TagNamesList {
  help: string,
  success: boolean,
  result: string[]
};