https://github.com/kormanowsky/replimod
The REST API client-side model utility class
https://github.com/kormanowsky/replimod
Last synced: 3 months ago
JSON representation
The REST API client-side model utility class
- Host: GitHub
- URL: https://github.com/kormanowsky/replimod
- Owner: kormanowsky
- Created: 2020-09-07T18:33:47.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-10T07:01:21.000Z (almost 6 years ago)
- Last Synced: 2025-05-29T16:45:56.990Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 127 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RePLiMod - The REST API client-side model utility class
## Meaning of the title
REst aPi cLIent MODel
## Purpose of the class
Replimod was developed in order to let developers save their time when creating a client for REST API.
This library provides a simple way of working with such API. It consists of the main class, called `Model` and a couple of utility functions used by the class.
## What is a Model?
A Model is a single data type, it is similar to tables in the database.
`Model` class provides basic methods like `.create()` for creating new instances or `.delete()` for removing existng ones.
The class may be extended by developers to achieve custom behaviour such as custom API methods or request authorization.
## Installation
`npm install replimod`
## How to use it.
You may find a working example in `example.js`