teamspeak-filesystem

Wrapper built around teamspeak-query to interface with the teamspeak filesystem.

Installation

$ npm install teamspeak-filesystem

Example

const fs = require('fs');

const TeamspeakQuery = require('teamspeak-query');
const TeamspeakFS = require('teamspeak-filesystem');

const query = new TeamspeakQuery();
const tsfs = TeamspeakFS(query); // Requires an instance of teamspeak-query

query.send('login', 'username', 'password')
    .then(() => query.send('use', 1))
    .then(() => tsfs.upload(1, '/filename', 'Hello World!\n'))
    .then(() => tsfs.download(1, '/filename'))
    .then(data => data.pipe(fs.createWriteStream('./hello'))
    .catch(console.error)

API Reference

Wrapper to interface with the teamspeak filesystem

| Param | Type | Description | | ----- | ------------------- | --------------------------- | | query | Object | Instance of teamspeak-query |

Example

const TeamspeakQuery = require('teamspeak-query');
const TeamspeakFS = require('teamspeak-filesystem');

const query = new TeamspeakQuery(); 
const tsfs = TeamspeakFS(query);

• TeamspeakFS
  • .upload(cid, name, data, options) ⇒ Promise
  • .download(cid, name, options) ⇒ net.Socket
  • .currentTransfers()
  • .getFiles(cid, path, cpw) ⇒ Array
  • .getFileInfo(cid, name, cpw) ⇒ Object
  • .delete(cid, name, cpw)
  • .makeDir(cid, dirname, cpw)
  • .rename(cid, oldname, newname, options)

TeamspeakFS.upload(cid, name, data, options) ⇒ Promise

Upload a file

Kind: static method of TeamspeakFS
Returns: Promise - Resolves and rejects according to the success of the upload

| Param | Type | Description | | ------- | ------------------- | --------------------------------------------------------- | | cid | Number | The channel in which to upload the file (given by its id) | | name | String | The name of the file | | data | Any | The content of the file | | options | Object | Any other options (passed to TeamspeakQuery.send) |

TeamspeakFS.download(cid, name, options) ⇒ net.Socket

Download a file

Kind: static method of TeamspeakFS
Returns: net.Socket - A stream containing the files content

| Param | Type | Description | | ------- | ------------------- | ------------------------------------------------- | | cid | Number | The channel in which the file is saved | | name | String | The name of the file | | options | Object | Any other options (passed to TeamspeakQuery.send) |

TeamspeakFS.currentTransfers()

Get a list of currently running file transfers

Kind: static method of TeamspeakFS

TeamspeakFS.getFiles(cid, path, cpw) ⇒ Array

Get all files in a channel for a given path

Kind: static method of TeamspeakFS
Returns: Array - A list of files in the channel.

| Param | Type | Description | | ----- | ------------------- | -------------------------------- | | cid | Number | The channel of the file | | path | String | The path | | cpw | String | The channel password (if needed) |

TeamspeakFS.getFileInfo(cid, name, cpw) ⇒ Object

Gets information about a given file

Kind: static method of TeamspeakFS
Returns: Object - The file information.

| Param | Type | Description | | ----- | ------------------- | -------------------------------- | | cid | Number | The channel of the file | | name | String | The path to the file | | cpw | String | The channel password (if needed) |

TeamspeakFS.delete(cid, name, cpw)

Delete a file

Kind: static method of TeamspeakFS

| Param | Type | Description | | ----- | ------------------- | -------------------------------- | | cid | Number | The channel of the file | | name | String | The path to the file | | cpw | String | The channel password (if needed) |

TeamspeakFS.makeDir(cid, dirname, cpw)

Create a directory

Kind: static method of TeamspeakFS

| Param | Type | Description | | ------- | ------------------- | -------------------------------- | | cid | Number | The channel of the file | | dirname | String | The path of the directory | | cpw | String | The channel password (if needed) |

TeamspeakFS.rename(cid, oldname, newname, options)

Rename a given file

Kind: static method of TeamspeakFS

| Param | Type | Description | | ------- | ------------------- | ----------------------------------------------- | | cid | Number | The channel of the file | | oldname | String | The old/current name | | newname | String | The new name | | options | Object | Further options (passed to TeamspeakQuery.send) |