Class: BucketActions

Constructor

new BucketActions(bucket, region)

Parameters:

Name	Type	Description
`bucket`	Object	S3 Bucket name.
`region`	Object	S3 Region name.

Source: bucket/Actions.js, line 23

Example

const actions = new Actions('s3-is-not-a-db', 'us-east-1');

Methods

(async) batch(keyName, actions) → {Promise|Error}

Execute a batch operation in sequential order. Use "Pessimistic Locking" for data integrity.

Parameters:

Name	Type	Description
`keyName`	String	Object name.
`actions`	Array.<Promise>	Array of promised Actions.

Source: bucket/Actions.js, line 274

Returns:

Type:: Promise | Error

Example

const keyName = 'file.json';
const operations = [];

// Fetch the object.
operations.push(() => {
  return actions.fetch(keyName);
});

// Update existing data.
operations.push(data => {
  return actions.write(keyName, {...data, foo: 'bar'}));
});

actions.batch(keyName, operations)
  .catch(function(err) {
    console.warn(err.message);
  });

(async) delete(keyName) → {Promise.<(Object|Error)>}

Delete object.

Parameters:

Name	Type	Description
`keyName`	String	Object name.

Source: bucket/Actions.js, line 107

Returns:

Type:: Promise.<(Object|Error)>

Example

actions.prefix = 'path/to/object';

await actions.delete('keyName');

(async) exists(keyName) → {Promise.<(Object|Boolean|Error)>}

Check object exists.

Parameters:

Name	Type	Description
`keyName`	String	Object name.

Source: bucket/Actions.js, line 239

Returns:

Type:: Promise.<(Object|Boolean|Error)>

Example

actions.prefix = 'path/to/object';

const exists = await actions.exists('keyName');

(async) fetch(keyName) → {Promise.<(Object|Error)>}

Fetch object.

Parameters:

Name	Type	Description
`keyName`	String	Object name.

Source: bucket/Actions.js, line 128

Returns:

Type:: Promise.<(Object|Error)>

Example

actions.prefix = 'path/to/object';

const data = await actions.fetch('keyName');

(async) isLocked(keyName) → {Promise.<(Boolean|Error)>}

Check object lock exists.

Parameters:

Name	Type	Description
`keyName`	String	Object name.

Source: bucket/Actions.js, line 310

Returns:

Type:: Promise.<(Boolean|Error)>

Example

actions.prefix = 'path/to/object';

const result = await actions.isLocked('keyName');

isValidData(obj) → {Boolean}

Check object keys match Model fields.

Parameters:

Name	Type	Description
`obj`	Object	Data as object.

Source: bucket/Actions.js, line 381

Returns:

Type:: Boolean

Example

const result = actions.isValidData({foo: true, bar: false});

(async) list() → {Promise.<(Object|Error)>}

List objects.

Source: bucket/Actions.js, line 90

Returns:

Type:: Promise.<(Object|Error)>

Example

actions.prefix = 'path/to/objects';

const objects = await actions.list();
// ['foo.ext', 'bar.ext', 'biz.ext', 'baz.ext']

(async) lockObject(keyName) → {Promise.<(undefined|Error)>}

Create object lock.

Parameters:

Name	Type	Description
`keyName`	String	Object name.

Source: bucket/Actions.js, line 335

Returns:

Type:: Promise.<(undefined|Error)>

Example

actions.prefix = 'path/to/object';

await actions.lockObject('keyName');

(async) rename(oldKeyName, newKeyName) → {Promise.<(Object|Error)>}

Rename object.

Parameters:

Name	Type	Description
`oldKeyName`	String	Old Object as string.
`newKeyName`	String	New object as string.

Source: bucket/Actions.js, line 216

Returns:

Type:: Promise.<(Object|Error)>

Example

actions.prefix = 'path/to/object';

await actions.rename('keyName1', 'keyName2');

(async) unlockObject(keyName) → {Promise.<(undefined|Error)>}

Remove object lock.

Parameters:

Name	Type	Description
`keyName`	String	Object name.

Source: bucket/Actions.js, line 362

Returns:

Type:: Promise.<(undefined|Error)>

Example

actions.prefix = 'path/to/object';

await actions.unlockObject('keyName');

(async) write(keyName, data, contentType) → {Promise.<(Object|Error)>}

Write object.

Parameters:

Name	Type	Default	Description
`keyName`	String		Object name.
`data`	String \| Buffer		Object data.
`contentType`	String	text/plain	Object content type (default: 'text/plain')

Source: bucket/Actions.js, line 177

Returns:

Type:: Promise.<(Object|Error)>

Example

actions.prefix = 'path/to/object';

await actions.write('keyName', 'foo');
  ..

await actions.write('keyName', {foo1: 'bar'});
  ..

await actions.write('keyName', <Buffer>, 'image/jpeg; charset=utf-8');