Skip to content

The collection for your resources. Made specifically to work with arrays of objects from your API Responses.

License

Notifications You must be signed in to change notification settings

eloqjs/nuxt-collection

Repository files navigation

@eloqjs/nuxt-collection

npm version npm downloads Github Actions CI Code Climate maintainability Codecov Gitpod ready-to-code Contributions License

The collection for your resources. Made specifically to work with arrays of objects from your API Responses.

Nuxt Collection | Collection | Vue Collection

Features

  • Made specifically to work with arrays of objects
  • JSON API specification support
  • Extends the Array class
  • Names and conventions that makes sense
  • Models support, fully compatible with vue-api-query, sarala and coloquent
  • Integrable primaryKey, fresh and toQuery
  • TypeScript support

📖  Read the Documentation

Setup

  1. Add @eloqjs/nuxt-collection dependency to your project
yarn add @eloqjs/nuxt-collection # or npm install @eloqjs/nuxt-collection
  1. Add @eloqjs/nuxt-collection to the modules section of nuxt.config.js
{
  modules: [
    // Simple usage
    '@eloqjs/nuxt-collection',

    // With options
    ['@eloqjs/nuxt-collection', { /* module options */ }],
    
    // Module Options
    collection: {}
  ]
}

Contributing

You can contribute online with Gitpod:

Open in Gitpod

Or locally:

  1. Clone this repository
  2. Install dependencies using yarn install
  3. Start development server using yarn dev

Credits

License

MIT License

Copyright (c) João Pedro Antunes Silva