hoodie-client v3.4.1
hoodie-client
Hoodie’s client for the browser
Hoodie’s client glue code that integrates Hoodie’s client core modules: account, store and task
Example
var Hoodie = require('hoodie-client')
var hoodie = new Hoodie(options)
hoodie.account.signUp({
username: 'pat@Example.com',
password: 'secret'
}).then(function (accountAttributes) {
hoodie.log.info('Signed up as %s', accountAttributes.username)
}).catch(function (error) {
hoodie.log.error(error)
})
API
- Constructor
- hoodie.url
- hoodie.account
- hoodie.store
- hoodie.task
- hoodie.connectionStatus
- hoodie.log
- hoodie.request
- hoodie.plugin
- hoodie.reset
- hoodie.on
- hoodie.one
- hoodie.off
- hoodie.trigger
- Events
Constructor
new Hoodie(options)
hoodie.url
Read-only
hoodie.url
full url to the hoodie server, e.g. http://example.com/hoodie
hoodie.account
hoodie.account
is an instance of hoodie-account-client.
See account API
hoodie.store
hoodie.store
is an instance of hoodie-store.
See store API
hoodie.task
hoodie.task
is an instance of hoodie-client-task.
See task API
hoodie.connectionStatus
hoodie.connectionStatus
is an instance of hoodie-connection-status.
See connectionStatus API
hoodie.log
hoodie.log
is an instance of hoodie-log.
See log API
hoodie.request
Sends an http request
hoodie.request(url)
// or
hoodie.request(options)
Examples
// sends a GET request to hoodie.url + '/foo/api/bar'
hoodie.request('/foo/api/bar')
// sends a GET request to another host
hoodie.request('https://example.com/foo/bar')
// sends a PATCH request to /foo/api/bar
hoodie.request({
method: 'PATCH',
url: '/foo/api/bar',
headers: {
'x-my-header': 'my value'
},
data: {
foo: 'bar'
}
})
hoodie.plugin
Initialise hoodie plugin
hoodie.plugin(methods)
hoodie.plugin(plugin)
Examples
hoodie.plugin({
sayHi: function () { alert('hi') }
})
hoodie.plugin(function (hoodie) {
hoodie.sayHi = function () { alert('hi') }
})
hoodie.reset
🐕 TO BE DONE: #12
Reset hoodie client and emit reset
event so plugins can reset as well.
hoodie.reset()
Resolves without argument.
hoodie.on
Subscribe to event.
hoodie.on(eventName, handler)
Example
hoodie.on('account:signin', function (accountProperties) {
alert('Hello there, ' + accountProperties.username)
})
hoodie.one
Call function once at given event.
hoodie.one(eventName, handler)
Example
hoodie.one('mycustomevent', function (options) {
console.log('foo is %s', options.bar)
})
hoodie.trigger('mycustomevent', { foo: 'bar' })
hoodie.trigger('mycustomevent', { foo: 'baz' })
// logs "foo is bar"
// DOES NOT log "foo is baz"
hoodie.off
Removes event handler that has been added before
hoodie.off(eventName, handler)
Example
hoodie.off('connectionstatus:disconnect', showNotification)
hoodie.trigger
Trigger custom events
hoodie.trigger(eventName[, option1, option2, ...])
Example
hoodie.trigger('mycustomevent', { foo: 'bar' })
Events
Testing
Local setup
git clone https://github.com/hoodiehq/hoodie-client.git
cd hoodie-client
npm install
Run all tests
npm test
Run test from one file only
node tests/specs/id
License
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago