Home

This module is meant to be interfaced in some way as a replacement for your Data Access Layer (DAL).

Quick Start

contentpull was meant to be extended into your DAL. Consider the following example:

const Contentpull = require('contentpull');

class DataAccessLayer extends Contentpull {
    
    getAllPosts() {
        return this.getEntriesByType('post').parse();
    }
    
    getAllAuthors() {
        return this.getEntriesByType('author').parse();
    }
}

module.exports = DataAccessLayer;

The above example shows how contentpull can be used to simplify and parse all data before it is used in your application.

Assuming the above file exists in the current directory as dal.js, you can use the next example to create an instance of your DAL:

const Dal = require('./dal');

// NOTE: We recommend you do not hard-code your spaceid or access key.
const dal = new Dal('space-id', 'api-key');

dal.getAllPosts().then(posts => {
    console.log(posts.items.length + " returned from contentful");
});

Promises

The wrapper (along with contentful.js) uses a Promise-driven architecture. All requests will respond with a promise.

Assuming we are in the context of our DataAccessLayer from the code-block above, the following can be used to get an entry, where entryId is the id of the entry in contentful.

getEntryById(entryId) {
    return this.getEntryById(entryId).then((entry) => {
        // assuming there is a title attribute
        console.log(entry.fields.title);
    }, function (err) {
        console.log(err);
    });
}

Parsing

This is where contentpull becomes extremely useful. The function in the above example would simply return example what contentful.js would return from an entry request.

This package supports parsing your content specific for your use within your application. contentpull will always return an "augmented" promise, in that it supports an additional feature to parse the data before resolving. This can be achieved in a number of ways:

Chaining

This method uses the parser as a chain that runs before resolving. With this approach, you can have the content resolved, as part of the promise-chain.

puller.getEntryById(entryId).parse().then((entry) => {
    // entry is now parsed
});

Replacement

With the replacement method, you can replace the .then() function with .parse() and it will functionally work the same, only this time you will have parsed data.

puller.getEntryById(entryId).parse((entry) => {
    // entry is now parsed
});