{"id":16617183,"url":"https://github.com/molovo/consumer","last_synced_at":"2025-04-05T00:18:02.558Z","repository":{"id":153210953,"uuid":"103055177","full_name":"molovo/consumer","owner":"molovo","description":"A tiny REST API consumer for JavaScript projects","archived":false,"fork":false,"pushed_at":"2020-03-12T21:11:00.000Z","size":44,"stargazers_count":4,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-10T08:32:49.517Z","etag":null,"topics":["api-client","fetch","javascript","rest-api"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/molovo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-10T19:16:49.000Z","updated_at":"2020-03-12T21:08:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"09398852-ad12-42b9-97af-dd4fe17dd4a1","html_url":"https://github.com/molovo/consumer","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/molovo%2Fconsumer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/molovo%2Fconsumer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/molovo%2Fconsumer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/molovo%2Fconsumer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/molovo","download_url":"https://codeload.github.com/molovo/consumer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247266568,"owners_count":20910837,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-client","fetch","javascript","rest-api"],"created_at":"2024-10-12T02:15:37.709Z","updated_at":"2025-04-05T00:18:02.553Z","avatar_url":"https://github.com/molovo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Consumer\n\n[![npm](http://img.shields.io/npm/v/api-consumer.svg?style=flat)](https://badge.fury.io/js/api-consumer) [![tests](http://img.shields.io/travis/molovo/consumer/master.svg?style=flat)](https://travis-ci.org/molovo/consumer) [![dependencies](http://img.shields.io/david/molovo/consumer.svg?style=flat)](https://david-dm.org/molovo/consumer)\n\nA tiny REST API consumer for JavaScript projects\n\n## Installation\n\n```sh\nnpm install --save api-consumer\n```\n\nThis project uses modern JavaScript API's, and does not polyfill anything. To use Consumer in older browsers, you will need to provide your own polyfills for `fetch`, `Promise` and `Proxy` as required.\n\n## Usage\n\nConsumer uses proxy objects to allow using chainable properties to construct a url for a REST API endpoint, and then execute the request for you. Each property you chain is appended to the url, and returns a new proxy. If you call one of the methods `all`, `find`, `create`, `update`, or `delete` at any point in the chain, a `fetch` request is executed, and the parsed JSON response is returned to you in a Promise.\n\nSee below for a brief explanation of functionality, or try out Consumer in the playground on [RunKit](https://runkit.com/molovo/api-consumer).\n\n### Making Requsests\n\n```js\nimport consume from 'api-consumer'\n\n// Create the proxy with your API's base URL\nconst api = consume('https://your.domain.com/api')\n\n// GET https://your.domain.com/api/users\nconst users = await api.users.all()\n\n// GET https://your.domain.com/api/your/deeply/nested/endpoint\nconst users = await api.your.deeply.nested.endpoint.all()\n\n// GET https://your.domain.com/api/users/123/posts\nconst posts = await api.users[123].posts.all()\n\n// GET https://your.domain.com/api/users/123\nconst user = await api.users.find(123)\n\n// POST https://your.domain.com/api/users\nconst newUser = await api.users.create({\n  name: 'James Dinsdale',\n  email: 'hi@molovo.co'\n})\n\n// PUT https://your.domain.com/api/users/123\nconst updatedUser = await api.users.update(123, {\n  name: 'A new name'\n})\n\n// DELETE https://your.domain.com/api/users/123\nconst deletedUser = await api.users.delete(123)\n```\n\n### Using Models\n\nBy default, a request made with a consumer returns a `Model` instance, or a `Collection`.\n\n```js\nimport {consume, Model} from 'api-consumer'\nconst api = consume('https://your.domain.com/api')\n\n// GET https://your.domain.com/api/books\n// @returns {Promise\u003cCollection[Model]\u003e}\nconst book = await api.books.all(123)\n\n// GET https://your.domain.com/api/books/123\n// @returns {Promise\u003cModel\u003e}\nconst book = await api.books.find(123)\nbook.title = 'A new title'\n\n// PUT https://your.domain.com/api/books/123\n// @returns {Promise\u003cBoolean\u003e}\nlet saved = await book.save()\n\n// DELETE https://your.domain.com/api/books/123\n// @returns {Promise\u003cBoolean\u003e}\nlet deleted = await book.delete()\n```\n\nYou can extend the model's functionality by creating your own model classes.\n\n```js\nimport {consume, Model} from 'api-consumer'\nconst api = consume('https://your.domain.com/api')\n\n// Extend the model class\nclass Book extends Model {\n  // Specify a Consumer instance to use as an endpoint\n  static consumer = api.books\n\n  // Optionally specify a custom primary key field (The default is 'id')\n  // The value of this field is used in the URL for update, create and delete\n  static primaryKeyField = 'uuid'\n\n  // Override getters and setters\n  get title () {\n    return 'Rainbows!'\n  }\n}\n```\n\nNow you can query your model class directly.\n\n```js\n// GET https://your.domain.com/api/books\nconst books = await Book.all()\n\n// GET https://your.domain.com/api/books/123\nconst book = await Book.find(123)\nbook.title = 'A new title'\n\n// PUT https://your.domain.com/api/books/123\nlet saved = await book.save()\n\n// DELETE https://your.domain.com/api/books/123\nlet deleted = await book.delete()\n```\n\nYou can also use the constructor to create new resources.\n\n```js\nconst book = new Book()\nbook.title = 'A title'\nbook.author = 'Joe Bloggs'\n\n// POST https://your.domain.com/api/books\n// @returns {Promise\u003cBoolean\u003e}\nlet created = await book.save()\n\n// Creating statically has the same effect\n// @returns {Promise\u003cModel\u003e}\nconst book = Book.create({\n  title: 'A title',\n  author: 'Joe Bloggs'\n})\n```\n\n#### Overiding `fetch` options\n\nThe default options passed to `fetch` are:\n\n```js\n{\n  credentials: true,\n  headers: {\n    'Content-Type': 'application/json'\n  }\n}\n```\n\nYou can override these by passing an object as the second argument to `consume`.\n\n```js\nconst api = consume('https://myapi.com', {\n  credentials: false\n})\n```\n\n**NOTE:** Specifying `method` in the default options will have no effect, since it is overridden by each of the executing methods.\n\n## License \u0026 Contributing\n\n- Details on the license [can be found here](LICENSE.md)\n- Details on running tests and contributing [can be found here](contributing.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmolovo%2Fconsumer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmolovo%2Fconsumer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmolovo%2Fconsumer/lists"}