nexusdocs-client v0.3.4

nexusdocs-client

Client-SDK for nexusdocs-server

NexusDocs Documentation

Use

npm install nexusdocs-client

Modules

Classes

nexusdocs-client

module.exports(options) ⇒ Client ⏏

Create a NexusDocs client instance

Kind: Exported function
See: new Client()

Example
Create a client

const createClient = require('nexusdocs-client');

// Object style server options:
const client = createClient({
  hostname: '192.168.1.6',
  port: 4001,
  apiKey: 'MY_API_KEY',
  apiSecret: 'MY_API_SECRET',
});

// URL style server options:
const client = createClient('http://MY_API_KEY:MY_API_SECRET@192.168.1.6:4001/api');

Client

Class presenting NexusDocs client instance

Kind: global class

• Client
  • new Client(options)
  • instance
    • .getNamespace(name, [options]) ⇒ Namespace
  • inner
    • ~ServerOptions : object

new Client(options)

Creates an instance of NDS Client.

Example
You can pass a URL sting instead of a config object:

http://<clientKey>:<clientSecret>@<hostname>:<port><endPoint>

client.getNamespace(name, options) ⇒ Namespace

Get namespace instance

Kind: instance method of Client
Returns: Namespace - Namespace instance

Client~ServerOptions : object

Server options

Kind: inner typedef of Client
Properties

Namespace

Class presenting NexusDocs namespace instance

Kind: global class

• Namespace
  • new Namespace(client, name, options)
  • instance
    • .getUploadUrl([options]) ⇒ string
    • .getDownloadUrl(fileId, [options]) ⇒ string
    • .getConvertedUrl(fileId, converting, [options]) ⇒ string
    • .upload(Buffer|ReadableStream, [options]) ⇒ Promise
    • .openUploadStream([options]) ⇒ WritableStream
    • .uploadFromLocal(filePath, options) ⇒ Promise
    • .openDownloadStream(fileId, [options]) ⇒ ReadableStream
    • .downloadToLocal(fileId, filePath, [options]) ⇒ Promise
    • .getFileInfo(fileId) ⇒ Promise
    • .delete(fileId) ⇒ Promise
    • .truncate() ⇒ Promise
    • .createArchive(files) ⇒ Promise
    • .getArchiveUrl(files, options)
  • inner
    • ~RequestOptions : object
    • ~UploadOptions : object
    • ~DownloadOptions : object
    • ~FileId : string
    • ~ImageInfo : object
    • ~ZipFileEntry : object
    • ~ZipInfo : object
    • ~FileInfo : object
    • ~ConvertingOptions : object

new Namespace(client, name, options)

Namespace Class constructor

Example
Create a namespace instance

const namespace = client.getNamespace('a.name.space');

namespace.getUploadUrl(options) ⇒ string

Get URL for upload

Kind: instance method of Namespace
Returns: string - URL for upload

namespace.getDownloadUrl(fileId, options) ⇒ string

Get file URL for view or download

Kind: instance method of Namespace
Returns: string - file URL

namespace.getConvertedUrl(fileId, converting, options) ⇒ string

Get the converted file URL for view or download

Kind: instance method of Namespace
Returns: string - The converted file URL

namespace.upload(Buffer|ReadableStream, options) ⇒ Promise

Upload file from Buffer, ReadableStream

Kind: instance method of Namespace
Fulfil: object File info when uploading is finished
Reject: any Request error

namespace.openUploadStream(options) ⇒ WritableStream

Get upload stream

Kind: instance method of Namespace
Returns: WritableStream - Writable stream for upload

namespace.uploadFromLocal(filePath, options) ⇒ Promise

Upload a file from local file-system

Kind: instance method of Namespace
Fulfil: FileInfo File info when uploading is finished
Reject: any Request error

namespace.openDownloadStream(fileId, options) ⇒ ReadableStream

Get a readable stream for download

Kind: instance method of Namespace
Returns: ReadableStream - - the readable stream

namespace.downloadToLocal(fileId, filePath, options) ⇒ Promise

Download a file to local file-system

Kind: instance method of Namespace
Fulfil: any Download finished

namespace.getFileInfo(fileId) ⇒ Promise

Get file information

Kind: instance method of Namespace
Fulfil: FileInfo file information

namespace.delete(fileId) ⇒ Promise

Delete a file on the server

Kind: instance method of Namespace
Fulfil: object When deletion is finished
Reject: any When a error occur

namespace.truncate() ⇒ Promise

Delete all files in this namespace

Kind: instance method of Namespace

namespace.createArchive(files) ⇒ Promise

Create an archive

Kind: instance method of Namespace

namespace.getArchiveUrl(files, options)

Archive files then return download URL

Kind: instance method of Namespace

Namespace~RequestOptions : object

Request options for request, some properties are added for additional use, see specified method

Kind: inner typedef of Namespace
Properties

Namespace~UploadOptions : object

Upload request options

Kind: inner typedef of Namespace
Extends: RequestOptions
Properties

Namespace~DownloadOptions : object

Download options

Kind: inner typedef of Namespace
Extends: RequestOptions
Properties

Namespace~FileId : string

File identifier

Kind: inner typedef of Namespace
Example

Example file id: `e5ac71cf-a0f0-46b5-9070-268ae97bb769`

Namespace~ImageInfo : object

Image file info

Kind: inner typedef of Namespace
Properties

Namespace~ZipFileEntry : object

Zip file entry

Kind: inner typedef of Namespace
Properties

Namespace~ZipInfo : object

Zip file info

Kind: inner typedef of Namespace
Properties

Namespace~FileInfo : object

File information

Kind: inner typedef of Namespace
Properties

Namespace~ConvertingOptions : object

File converting options

Kind: inner typedef of Namespace
Properties

Example
Get a thumbnail of size 32px

{
  format: 'jpeg',
  resize: '32x32',
  rotate: 'auto'
}

Example
Get a pdf version of a document

{
  format: 'pdf',
}

License

MIT