0.0.1 • Published 7 years ago
bridalapp-client v0.0.1
bridalapp-client-js
Javascript client for Bridal App API Server
Install with NPM
npm install --save bridalapp-client
Direct download
Include in your app
require
var bridalapp = require('bridalapp-client').bridalapp
// or, if you want to use a client with custom options
var client = require('bridalapp-client').client
import
import { bridalapp } from 'bridalapp-client'
// or, if you want to use a client with custom options
import { client } from 'bridalapp-client'
AMD
define(['bridalapp-client'], function(bridalappClient){
var bridalapp = bridalappClient.bridalapp
// Or, if you want to use a client with custom options
var client = bridalappClient.client
});
Script tag
<script src="https://cdn.rawgit.com/download/bridalapp-client-js/0.1.0/bridalapp-client.min.js"></script>
<script>
var bridalapp = window['bridalapp-client'].bridalapp
// Or, if you want to use a client with custom options
var client = window['bridalapp-client'].client
</script>
Usage
The easiest way is to grab the default client, bridalapp
, that has the default options applied. Then
make API calls on it:
import { bridalapp, Category } from 'bridalapp-client'
var onSale = bridalapp.products.search(Category.WEDDING_DRESSES, 'sale', 100, 0)
If you want to set custom options, use client
:
// all options are optional
var options = {
// fetch: myFetchFunction,
// log: myLoggerObject
}
var myClient = client(options)
var onSale = myClient.products.search(Category.WEDDING_DRESSES, 'sale', 100, 0)
The objects returned by client
are stateless and should be treated as immutable.
Options
These options can be specified when
Issues
Add an issue in this project's issue tracker to let me know of any problems you find, or questions you may have.
Copyright
Copyright 2017 by Stijn de Witt. Some rights reserved.
License
Licensed under the Creative Commons Attribution 4.0 International (CC-BY-4.0) Open Source license.