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

api_cloudflare_client

v3.4.2

Published

CloudFlare API client

Downloads

94

Readme

Cloudflare Node.js bindings

Stability Stable Coverage Status NPM version Libraries.io Dependencies NPM downloads

Cloudflare v4 API bindings for Node.js, providing a sourdough "BREAD" (Browse, Read, Edit, Add, and Delete) interface.

With these bindings, you'll get the following features:

  • A Promise-based API. With modern versions of Node.js, this can be leveraged for async/await and generator support.
  • Automatic handling of Gzip/Deflate compression.

Node.js v12 and greater are supported.

Configuration

API Keys

Set your account email address and API key. The API key can be found on the My Profile -> API Tokens page in the Cloudflare dashboard.

const cfInstance = require('api_cloudflare_client')({
  email: '[email protected]',
  key: 'your Cloudflare API key'
});
import Cloudflare from 'api_cloudflare_client'


export default class CloudflareController {
  constructor(private config: ConfigurationsController) {
    this.config = config
  }

  async cloudflareInstance(): Promise<Cloudflare> {
    const email = await this.config.get('cf.X-Auth-Email')
    const key = await this.config.get('cf.X-Auth-Key')
    // console.log(email, key)
    if (typeof key !== 'string' || typeof email !== 'string')
      throw new Error('Cloudflare credentials not found')
    return new Cloudflare({email: email, key: key})
  }
}

API Tokens (BETA)

Create your token on the My Profile -> API Tokens page in the Cloudflare dashboard.

javascript
const cfInstance = require('api_cloudflare_client')({
  token: 'your Cloudflare API token'
});

API Overview

Every resource is accessed via your cfInstance instance:

// cf.{ RESOURCE_NAME }.{ METHOD_NAME }

Every resource method returns a promise, which can be chained or used with async/await.

cfInstance.zones.read('023e105f4ecef8ad9ca31a8372d0c353'