resource-replication v0.4.2
replication
for managing and keeping track of replication events
API
properties
methods
create (options, callback)
get (id, callback)
find (options, callback)
all (callback)
update (options, callback)
updateOrCreate (options, callback)
destroy (id, callback)
properties
for managing and keeping track of replication events
id
- type : any
time
description : the date and time of the replication
type : string
default : Thu May 23 2013 16:58:45 GMT-0700 (PDT)
source
description : the source of the replication ( where the code is coming from )
type : string
target
description : the target of the replication ( where the code is going )
type : string
repo
- type : string
branch
- type : string
methods
replication.create(options, callback)
create a new replication
options
type : object
properties
id
- type : any
time
description : the date and time of the replication
type : string
default : Thu May 23 2013 16:58:45 GMT-0700 (PDT)
source
description : the source of the replication ( where the code is coming from )
type : string
target
description : the target of the replication ( where the code is going )
type : string
repo
- type : string
branch
- type : string
callback
- type : function
replication.get(id, callback)
get replication by id
id
type : any
description : the id of the object
required : true
callback
- type : function
replication.find(options, callback)
search for instances of replication
options
type : object
properties
id
type : any
default :
required : false
time
description : the date and time of the replication
type : any
default :
required : false
source
description : the source of the replication ( where the code is coming from )
type : any
default :
required : false
target
description : the target of the replication ( where the code is going )
type : any
default :
required : false
repo
type : any
default :
required : false
branch
type : any
default :
required : false
callback
- type : function
replication.all(callback)
gets all instances of replication
callback
- type : function
replication.update(options, callback)
updates a replication by id
options
type : object
properties
id
- type : any
time
description : the date and time of the replication
type : string
default : Thu May 23 2013 16:58:45 GMT-0700 (PDT)
source
description : the source of the replication ( where the code is coming from )
type : string
target
description : the target of the replication ( where the code is going )
type : string
repo
- type : string
branch
- type : string
callback
- type : function
replication.updateOrCreate(options, callback)
updates a replication by id, and creates if necessary
options
type : object
properties
id
- type : any
time
description : the date and time of the replication
type : string
default : Thu May 23 2013 16:58:45 GMT-0700 (PDT)
source
description : the source of the replication ( where the code is coming from )
type : string
target
description : the target of the replication ( where the code is going )
type : string
repo
- type : string
branch
- type : string
callback
- type : function
replication.destroy(id, callback)
destroys a replication by id
id
type : string
description : the id of the object
required : true
callback
- type : function
README auto-generated with docs