Class default

Client for the Akamai NetStorage HTTP API.

Every operation comes in two forms: a callback method (stat, upload, ...) that receives (err, response, body), and a promise method with an Async suffix (statAsync, uploadAsync, ...) that resolves with the parsed body.

Example

import Netstorage from "ts-netstorageapi-akamai";

const ns = new Netstorage({
  hostname: "example-nsu.akamaihd.net",
  keyName: "upload-user",
  key: process.env.NETSTORAGE_KEY!,
  cpCode: "123456",
  ssl: true,
});

const { stat } = await ns.statAsync("/123456/hello.txt");

Constructors

constructor

new default(netstorageOpts: AkamaiConfig): default
Parameters
- netstorageOpts: AkamaiConfig
  Connection settings. hostname, keyName and key are required; ssl defaults to false; proxy is an optional http(s):// proxy URL.
Returns default

Throws
Error if hostname, keyName or key is missing, TypeError if ssl is not a boolean.
- Defined in netstorage.ts:93

Methods

delete

delete(
ns_path: string,
callback: (err: any, res?: IncomingMessage, body?: DeleteResponse) => void,
): void
Deletes a file or symlink (delete action).
Parameters
- ns_path: string
  Full path of the file.
- callback: (err: any, res?: IncomingMessage, body?: DeleteResponse) => void
  Receives the error, the HTTP response and the parsed body.
Returns void
- Defined in netstorage.ts:403

deleteAsync

deleteAsync(ns_path: string): Promise<DeleteResponse>
Deletes a file or symlink (delete action).
Parameters
- ns_path: string
  Full path of the file.
Returns Promise<DeleteResponse>
- Defined in netstorage.ts:418

dir

dir(
opts: string | DirListOpts,
callback: (err: any, res?: IncomingMessage, body?: DirResponse) => void,
): void
Lists a directory (dir action).
Parameters
- opts: string | DirListOpts
  Directory path, or { path, actions } with DirOpts.
- callback: (err: any, res?: IncomingMessage, body?: DirResponse) => void
  Receives the error, the HTTP response and the parsed body.
Returns void
Example
```
ns.dir({ path: "/123456/images", actions: { max_entries: "100" } }, (err, res, body) => {
  if (!err && res.statusCode === 200) console.log(body.stat.file);
});
```
- Defined in netstorage.ts:117

dirAsync

dirAsync(opts: string | DirListOpts): Promise<DirResponse>
Lists a directory (dir action).
Parameters
- opts: string | DirListOpts
  Directory path, or { path, actions } with DirOpts.
Returns Promise<DirResponse>
The parsed listing: body.stat.attribs.directory and body.stat.file[].
Example
```
const { stat } = await ns.dirAsync("/123456/images");
stat.file.forEach((f) => console.log(f.type, f.name, f.size));
```
- Defined in netstorage.ts:135

download

download(
    ns_path: string,
    local_destination: string,
    callback: (
        err: any,
        res?: IncomingMessage,
        body?: DownloadResponse,
    ) => void,
): void
Downloads a file to the local disk.
Parameters
- ns_path: string
  NetStorage file path (not a directory).
- local_destination: string
  Local file or directory. Pass "" (or omit it in JavaScript) to use the NetStorage file name in the current directory; a directory keeps the NetStorage file name.
- callback: (err: any, res?: IncomingMessage, body?: DownloadResponse) => void
  Receives the error, the HTTP response and { message: "Download Done." }. Check res.statusCode: the response body is written to disk whatever the status.
Returns void
- Defined in netstorage.ts:169

downloadAsync

downloadAsync(
ns_path: string,
local_destination: string,
): Promise<DownloadResponse>
Downloads a file to the local disk.
Parameters
- ns_path: string
  NetStorage file path (not a directory).
- local_destination: string
  Local file or directory. Pass "" to use the NetStorage file name in the current directory; a directory keeps the NetStorage file name.
Returns Promise<DownloadResponse>
{ message: "Download Done." }. The response body is written whatever the HTTP status; use Netstorage.download if you need the status code.
- Defined in netstorage.ts:200

downloadBuffer

downloadBuffer(
    ns_path: string,
    callback: (
        err: any,
        res?: IncomingMessage,
        body?: DownloadBufferResponse,
    ) => void,
): void
Downloads a file into memory.
Parameters
- ns_path: string
  NetStorage file path (not a directory).
- callback: (err: any, res?: IncomingMessage, body?: DownloadBufferResponse) => void
  Receives the error, the HTTP response and { buffer, message }. At runtime body.buffer holds the bytes as a binary (latin1) string; convert it with Buffer.from(body.buffer as unknown as string, "binary") for a real Buffer.
Returns void
- Defined in netstorage.ts:219

downloadBufferAsync

downloadBufferAsync(ns_path: string): Promise<DownloadBufferResponse>
Downloads a file into memory.
Parameters
- ns_path: string
  NetStorage file path (not a directory).
Returns Promise<DownloadBufferResponse>
{ buffer, message }. At runtime buffer holds the bytes as a binary (latin1) string; convert it with Buffer.from(result.buffer as unknown as string, "binary") for a real Buffer.
- Defined in netstorage.ts:241

du

du(
ns_path: string,
callback: (err: any, res?: IncomingMessage, body?: DuResponse) => void,
): void
Disk usage of a directory (du action).
Parameters
- ns_path: string
  NetStorage directory path.
- callback: (err: any, res?: IncomingMessage, body?: DuResponse) => void
  Receives the error, the HTTP response and the parsed body.
Returns void
- Defined in netstorage.ts:259

duAsync

duAsync(ns_path: string): Promise<DuResponse>
Disk usage of a directory (du action).
Parameters
- ns_path: string
  NetStorage directory path.
Returns Promise<DuResponse>
body.du["du-info"][0] with files and bytes (as strings).
- Defined in netstorage.ts:275

list

list(
opts: string | DirListOpts,
callback: (err: any, res?: IncomingMessage, body?: ListResponse) => void,
): void
Lists files recursively under a path (list action).
Parameters
- opts: string | DirListOpts
  Path, or { path, actions } with ListOpts.
- callback: (err: any, res?: IncomingMessage, body?: ListResponse) => void
  Receives the error, the HTTP response and the parsed body.
Returns void
- Defined in netstorage.ts:144

listAsync

listAsync(opts: string | DirListOpts): Promise<ListResponse>
Lists files recursively under a path (list action).
Parameters
- opts: string | DirListOpts
  Path, or { path, actions } with ListOpts.
Returns Promise<ListResponse>
body.list.file[], plus body.list.resume[0].start when more entries remain.
- Defined in netstorage.ts:157

mkdir

mkdir(
ns_path: string,
callback: (err: any, res?: IncomingMessage, body?: MkdirResponse) => void,
): void
Creates a directory (mkdir action).
Parameters
- ns_path: string
  Full path of the directory to create.
- callback: (err: any, res?: IncomingMessage, body?: MkdirResponse) => void
  Receives the error, the HTTP response and the parsed body.
Returns void
- Defined in netstorage.ts:317

mkdirAsync

mkdirAsync(ns_path: string): Promise<MkdirResponse>
Creates a directory (mkdir action).
Parameters
- ns_path: string
  Full path of the directory to create.
Returns Promise<MkdirResponse>
- Defined in netstorage.ts:332

mtime

mtime(
    ns_path: string,
    mtime: number,
    callback: (err: any, res?: IncomingMessage, body?: MtimeResponse) => void,
): void
Sets the modification time of a file (mtime action).
Parameters
- ns_path: string
  NetStorage file path.
- mtime: number
  Unix time in seconds (no milliseconds).
- callback: (err: any, res?: IncomingMessage, body?: MtimeResponse) => void
  Receives the error, the HTTP response and the parsed body.
Returns void
- Defined in netstorage.ts:374

mtimeAsync

mtimeAsync(ns_path: string, mtime: number): Promise<MtimeResponse>
Sets the modification time of a file (mtime action).
Parameters
- ns_path: string
  NetStorage file path.
- mtime: number
  Unix time in seconds (no milliseconds).
Returns Promise<MtimeResponse>
- Defined in netstorage.ts:390

quickDelete

quickDelete(
    ns_path: string,
    callback: (
        err: any,
        res?: IncomingMessage,
        body?: QuickDeleteResponse,
    ) => void,
): void
Deletes a directory and everything in it (quick-delete action). Quick delete must be enabled on the CP code by Akamai.
Parameters
- ns_path: string
  Full path of the directory.
- callback: (err: any, res?: IncomingMessage, body?: QuickDeleteResponse) => void
  Receives the error, the HTTP response and the parsed body.
Returns void
- Defined in netstorage.ts:432

quickDeleteAsync

quickDeleteAsync(ns_path: string): Promise<QuickDeleteResponse>
Deletes a directory and everything in it (quick-delete action). Quick delete must be enabled on the CP code by Akamai.
Parameters
- ns_path: string
  Full path of the directory.
Returns Promise<QuickDeleteResponse>
- Defined in netstorage.ts:448

rename

rename(
    ns_target: string,
    ns_destination: string,
    callback: (err: any, res?: IncomingMessage, body?: RenameResponse) => void,
): void
Renames or moves a file (rename action).
Parameters
- ns_target: string
  Current path.
- ns_destination: string
  New path.
- callback: (err: any, res?: IncomingMessage, body?: RenameResponse) => void
  Receives the error, the HTTP response and the parsed body.
Returns void
- Defined in netstorage.ts:462

renameAsync

renameAsync(ns_target: string, ns_destination: string): Promise<RenameResponse>
Renames or moves a file (rename action).
Parameters
- ns_target: string
  Current path.
- ns_destination: string
  New path.
Returns Promise<RenameResponse>
- Defined in netstorage.ts:478

rmdir

rmdir(
ns_path: string,
callback: (err: any, res?: IncomingMessage, body?: RmdirResponse) => void,
): void
Removes an empty directory (rmdir action).
Parameters
- ns_path: string
  Full path of the directory.
- callback: (err: any, res?: IncomingMessage, body?: RmdirResponse) => void
  Receives the error, the HTTP response and the parsed body.
Returns void
- Defined in netstorage.ts:345

rmdirAsync

rmdirAsync(ns_path: string): Promise<RmdirResponse>
Removes an empty directory (rmdir action).
Parameters
- ns_path: string
  Full path of the directory.
Returns Promise<RmdirResponse>
- Defined in netstorage.ts:360

stat

stat(
ns_path: string,
callback: (err: any, res?: IncomingMessage, body?: StatResponse) => void,
): void
File or directory metadata (stat action).
Parameters
- ns_path: string
  NetStorage path.
- callback: (err: any, res?: IncomingMessage, body?: StatResponse) => void
  Receives the error, the HTTP response and the parsed body.
Returns void
- Defined in netstorage.ts:288

statAsync

statAsync(ns_path: string): Promise<StatResponse>
File or directory metadata (stat action).
Parameters
- ns_path: string
  NetStorage path.
Returns Promise<StatResponse>
body.stat.file[0] with type, name, mtime (and size, md5 for files).
- Defined in netstorage.ts:304

symlink

symlink(
    ns_target: string,
    ns_destination: string,
    callback: (err: any, res?: IncomingMessage, body?: SymlinkResponse) => void,
): void
Creates a symbolic link (symlink action).
Parameters
- ns_target: string
  Existing file the link points to.
- ns_destination: string
  Path of the new link.
- callback: (err: any, res?: IncomingMessage, body?: SymlinkResponse) => void
  Receives the error, the HTTP response and the parsed body.
Returns void
- Defined in netstorage.ts:492

symlinkAsync

symlinkAsync(
ns_target: string,
ns_destination: string,
): Promise<SymlinkResponse>
Creates a symbolic link (symlink action).
Parameters
- ns_target: string
  Existing file the link points to.
- ns_destination: string
  Path of the new link.
Returns Promise<SymlinkResponse>
- Defined in netstorage.ts:506

upload

upload(
    local_source: string,
    ns_destination: string,
    callback: (err: any, res?: IncomingMessage, body?: UploadResponse) => void,
): void
Uploads a local file (upload action).
Parameters
- local_source: string
  Path of the local file.
- ns_destination: string
  NetStorage file path, or a directory ending in / to keep the local file name.
- callback: (err: any, res?: IncomingMessage, body?: UploadResponse) => void
  Receives the error, the HTTP response and { message: "Request Processed." } on success.
Returns void
- Defined in netstorage.ts:521

uploadAsync

uploadAsync(
local_source: string,
ns_destination: string,
): Promise<UploadResponse>
Uploads a local file (upload action).
Parameters
- local_source: string
  Path of the local file.
- ns_destination: string
  NetStorage file path, or a directory ending in / to keep the local file name.
Returns Promise<UploadResponse>
{ message: "Request Processed." } on success.
Example
```
await ns.uploadAsync("./build/app.js", "/123456/static/");
```
- Defined in netstorage.ts:560

uploadBuffer

uploadBuffer(
    local_source: Buffer,
    basename: string,
    ns_destination: string,
    callback: (err: any, res?: IncomingMessage, body?: UploadResponse) => void,
): void
Uploads a Buffer (upload action), e.g. a generated file that never touches the disk.
Parameters
- local_source: Buffer
  File contents.
- basename: string
  File name used when ns_destination ends in /.
- ns_destination: string
  NetStorage file path, or a directory ending in /.
- callback: (err: any, res?: IncomingMessage, body?: UploadResponse) => void
  Receives the error, the HTTP response and { message: "Request Processed." } on success.
Returns void
- Defined in netstorage.ts:591

uploadBufferAsync

uploadBufferAsync(
    local_source: Buffer,
    basename: string,
    ns_destination: string,
): Promise<UploadResponse>
Uploads a Buffer (upload action), e.g. a generated file that never touches the disk.
Parameters
- local_source: Buffer
  File contents.
- basename: string
  File name used when ns_destination ends in /.
- ns_destination: string
  NetStorage file path, or a directory ending in /.
Returns Promise<UploadResponse>
{ message: "Request Processed." } on success.
Example
```
await ns.uploadBufferAsync(Buffer.from(JSON.stringify(data)), "data.json", "/123456/api/");
```
- Defined in netstorage.ts:629

Class default

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Throws

Methods

delete

Parameters

Returns void

deleteAsync

Parameters

Returns Promise<DeleteResponse>

dir

Parameters

Returns void

Example

dirAsync

Parameters

Returns Promise<DirResponse>

Example

download

Parameters

Returns void

downloadAsync

Parameters

Returns Promise<DownloadResponse>

downloadBuffer

Parameters

Returns void

downloadBufferAsync

Parameters

Returns Promise<DownloadBufferResponse>

du

Parameters

Returns void

duAsync

Parameters

Returns Promise<DuResponse>

list

Parameters

Returns void

listAsync

Parameters

Returns Promise<ListResponse>

mkdir

Parameters

Returns void

mkdirAsync

Parameters

Returns Promise<MkdirResponse>

mtime

Parameters

Returns void

mtimeAsync

Parameters

Returns Promise<MtimeResponse>

quickDelete

Parameters

Returns void

quickDeleteAsync

Parameters

Returns Promise<QuickDeleteResponse>

rename

Parameters

Returns void

renameAsync

Parameters

Returns Promise<RenameResponse>

rmdir

Parameters

Returns void

rmdirAsync

Parameters

Returns Promise<RmdirResponse>

stat