buttercms

ButterCMS JS client

Documentation

For a comprehensive list of examples, check out the API documentation.

Installation

Requires node.js version 4 or greater.

npm install buttercms --save

Butter can also be included directly in HTML:

<script src="https://unpkg.com/buttercms@^1.0.0/dist/butter.min.js"></script>

Overview

Every resource is accessed via your butter instance:

var butter = require('buttercms')('api_token_567abe');

Using ES6:

import Butter from 'buttercms';
const butter = Butter('api_token_567abe');

Using CDN:

<script>
  var butter = Butter('api_token_567abe');
</script>

Every resource method returns a promise:

// Get blog posts
butter.post.list({page: 1, page_size: 10}).then(function(response) {
  console.log(response)
})

// Get blog post
butter.post.retrieve("hello-world").then(function(response) {
  console.log(response)
})

// Get homepage content
butter.content.retrieve(["home"]).then(function(resp) {
  console.log(resp)
});

// Get pages
butter.content.retrieve(["pages"]).then(function(resp) {
  console.log(resp)
});

See our node app for a full example.

Available resources & methods

Where you see params it is a plain js object, e.g. {page: 1}

• post
  • retrieve(slug[, params])
  • list([params])
  • search(query[, params])
• category
  • retrieve(slug[, params])
  • list([params])
• tag
  • retrieve(slug[, params])
  • list([params])
• author
  • retrieve(slug[, params])
  • list([params])
• feed
  • retrieve(type[, params])
• content
  • retrieve(keys)

Localization

Setup locales in the ButterCMS dashboard and fetch localized content using the locale option:

// Get pages
butter.content.retrieve(["pages"], {locale: 'es'}).then(function(resp) {
  console.log(resp)
});

Test mode

Test mode can be used to setup a staging website for previewing content or for testing content during local development. To fetch content from test mode add an additional argument, true, to the package initialization:

var butter = require('buttercms')('your butter API token', true);

Or use an environment variable:

var butter = require('buttercms')('your butter API token', process.env.BUTTER_TEST_MODE);

Documentation

Documentation is available at https://buttercms.com/docs/api/node