Skip to content

developmentseed/hapi-response-meta

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hapi-response-meta

npm version Build Status

This Hapi plugin adds metadata to a hapi response.

Installation

$: npm install hapi-response-meta

Registration

var Hapi = require('hapi');

var hapi = new Hapi.Server();
hapi.connection();

hapi.register({
  register: require('hapi-response-meta'),
  options: {
    key: 'meta',
    content: {
        provided_by: 'Some Organization',
        site: 'example.com'
    },
    results: 'results',
    routes: ['/', '/api'],
    excludeFormats: ['csv']
  }
};

Example

curl -X GET http://www.example.com
{
    "meta": {
        "provided_by": "Some Organization",
        "site": "example.com"
    },
    "results": {
        "key": "value"
    }
}

Test

$ npm test

About

Top level meta data to hapijs responses

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •