Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

fortune-json-api

Package Overview
Dependencies
Maintainers
1
Versions
46
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

fortune-json-api

JSON API serializer for Fortune.

  • 1.1.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.6K
increased by17.07%
Maintainers
1
Weekly downloads
 
Created
Source

Fortune JSON API Serializer

Build Status npm Version License

This is a JSON API serializer for Fortune.js, which implements all of the features in the base specification, and follows the recommendations as much as possible.

$ npm install fortune-json-api

Usage

import fortune from 'fortune'
import jsonApi from 'fortune-json-api'

const store = fortune.create({
  serializers: [ {
    type: jsonApi,
    options: { ... }
  } ]
})

The options object is as follows:

  • inflectType: pluralize the record type name in the URI. Default: true.
  • inflectKeys: camelize the field names per record. Default: true.
  • maxLimit: maximum number of records to show per page. Default: 1000.
  • includeLimit: maximum depth of fields per include. Default: 3.
  • bufferEncoding: which encoding type to use for input buffer fields. Default: base64.
  • prefix: hyperlink prefix, without trailing slash. Default ''.

Internal options:

  • uriTemplate: URI template string.
  • allowLevel: HTTP methods to allow ordered by appearance in URI template.

License

This software is licensed under the MIT license.

Keywords

FAQs

Package last updated on 20 Aug 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc