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

pageclip

v1.0.0

Published

JS Pageclip API client

Downloads

44

Readme

node-pageclip

This is the official node.js API client for Pageclip.

Usage

npm install --save pageclip

Basic usage:

const Pageclip = require('pageclip')
let pageclip = new Pageclip(yourAPIKey)

// Send an item up to Pageclip
pageclip.send({some: 'data'}).then((response) => {
  console.log(response.status, response.data) // => 200, [{payload: {...}}]
}).then(() => {
  // Fetch all items
  return pageclip.fetch()
}).then((response) => {
  console.log(response.status, response.data) // => 200, [{payload: {...}}]
})

API

Pageclip(apiKey)

Create a Pageclip Object.

  • apiKey (String) - found in the web interface of Pageclip. Note that apiKey must be the private API key. Your public siteKey will not work!
const Pageclip = require('pageclip')
let pageclip = new Pageclip('abc123ABC123abc123abc123abc12345')

Pageclip::send([formName], data)

Send data to Pageclip.

  • formName (String; optional; default: 'default') - form to which you want to attach data.
  • data (Object or Array) - data you want to send up. When Object it will treat it as a single Item. If Array, it will treat each entry as an Item.
  • Returns a Promise with Object payload
    • status (Integer) - HTTP status code
    • form (String) - form name
    • data (Array of Items) - Returns all items that were saved. See Items
    • errors (Array of Objects) - Will be present if status >= 400. See Errors
let pageclip, promise, data
pageclip = new Pageclip('abc123ABC123abc123abc123abc12345')

// Send one item
data = {some: 'data'}
promise = pageclip.send(data).then((response) => {
  console.log(
    response.status, // 200
    response.form, // 'default'
    response.data    // [Item({some: 'data'})]
  )
})

// Send multiple items
data = [{some: 'data'}, {some: 'otherdata'}]
promise = pageclip.send(data).then((response) => {
  console.log(
    response.status, // 200
    response.form, // 'default'
    response.data    // [Item({some: 'data'}), Item({some: 'otherdata'})]
  )
})

// Send one item to a named form
data = {email: '[email protected]'}
promise = pageclip.send('mailinglist', data).then((response) => {
  console.log(
    response.status, // 200
    response.form, // 'mailinglist'
    response.data    // [Item({email: '[email protected]'})]
  )
})

Pageclip::fetch([formName])

Retrieve your data from Pageclip. At this time, it returns all items in the form—there is no pagination or slicing.

  • formName (String; optional; default: 'default') - form from which you want to fetch data.
  • Returns a Promise with Object payload
    • status (Integer) - HTTP status code
    • form (String) - form name
    • data (Array of Items) - All Items in the form. See Items
    • errors (Array of Objects) - Will be present if status >= 400. See Errors
let pageclip, promise
pageclip = new Pageclip('api_abc123ABC123abc123abc123abc12345')

// Fetch items from the default form
promise = pageclip.fetch().then((response) => {
  console.log(
    response.status, // 200
    response.form, // 'default'
    response.data    // [Item]
  )
})

// Fetch items from a named form
promise = pageclip.fetch('mailinglist').then((response) => {
  console.log(
    response.status, // 200
    response.form, // 'mailinglist'
    response.data    // [Item, Item]
  )
})

Items

All Item objects returned by the API will have the following shape:

  {
    itemEid: 'abc123ABC123abc123abc123abc12345',
    createdAt: '1983-06-29T14:48:00Z', // ISO date
    payload: {
      // the data from the user
    }
  }

Errors

API errors will return a response with an errors key that contains an Array of objects:

  {
    errors: [{
      message: 'Name is required',
      property: 'name' // If the error is associated with a property
    }, ...]
  }