npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

netstorageapi

v1.1.5

Published

Akamai Netstorage API for Node.js

Downloads

36,498

Readme

NetstorageAPI: Akamai Netstorage API for Node.js

npm package Build Status License

npm package

NetstorageAPI is Akamai Netstorage (File/Object Store) API for Node.js 4.0+ with native http module.

Table of Contents

Installation

To install Netstorage API with npm global:

$ npm install --global netstorageapi

or as a development dependency for your project:

$ npm install --save netstorageapi

Example

const Netstorage = require('netstorageapi')

// Defaults: SSL: false
const config = {
  hostname: 'astinobj-nsu.akamaihd.net',
  keyName: 'astinobj',
  key: 'xxxxxxxxxx',
  cpCode: '407617',
  ssl: false
}
// Don't expose KEY on your public repository.

const ns = new Netstorage(config)
const local_source = 'hello.txt'

// or `/${config.cpCode}/` will asume the destination filename is the same as the source
const netstorage_destination = `/${config.cpCode}/hello.txt`

ns.upload(local_source, netstorage_destination, (error, response, body) => {
  if (error) { // errors other than http response codes
    console.log(`Got error: ${error.message}`)
  }
  if (response.statusCode == 200) {
    console.log(body)
  }
}); 

// { message: 'Request Processed.' }

Methods

delete

↑ back to method list

  • Syntax:
ns.delete(NETSTORAGE_PATH, callback(err, response, body)) 
  • Parameters:

    | Name | Type | Description | | :---------- | :---------: | :------------------------------ | | NETSTORAGE_PATH | string | full path for the file, not the directory |

dir

↑ back to method list

  • Syntax:
ns.dir(NETSTORAGE_PATH|OPTIONS, callback(err, response, body))
  • Parameters:

    | Name | Type | Description | | :---------- | :---------: | :------------------------------ | | NETSTORAGE_PATH | string | full path for the directory | | OPTIONS | object | JSON object containing options for the dir method |

  • Valid Options:

  { path: '/your/path', 
    actions: { 
      max_entries: integer,
      start: '/start/path',
      end: '/end/path/',
      prefix: 'object-prefix',
      slash: 'both'
    }
  }

list

↑ back to method list

  • Syntax:
ns.list(NETSTORAGE_PATH|OPTIONS, callback(err, response, body))
  • Parameters:

    | Name | Type | Description | | :---------- | :---------: | :------------------------------ | | NETSTORAGE_PATH | string | full path to the file/directory | | OPTIONS | object | JSON object containing options for the list method |

  • Valid Options:

  { path: '/your/path', 
    actions: { 
      max_entries: integer,
      end: '/end/path/'
    }
  }

download

↑ back to method list

  • Syntax:
ns.download(NETSTORAGE_SOURCE, LOCAL_DESTINATION, callback(err, response, body))
  • Parameters:

    | Name | Type | Description | | :---------- | :---------: | :------------------------------ | | NETSTORAGE_SOURCE | string | Path to the file in NetStorage | | LOCAL_DESTINATION | string | Location on the local host to write the downloaded file to (Optional value) |

du

↑ back to method list

  • Syntax:
ns.du(NETSTORAGE_PATH, callback(err, response, body))
  • Parameters:

    | Name | Type | Description | | :---------- | :---------: | :------------------------------ | | NETSTORAGE_PATH | string | full path to the file/directory |

mkdir

↑ back to method list

  • Syntax:
ns.mkdir(DIRECTORY_NAME, callback(err, response, body))
  • Parameters:

    | Name | Type | Description | | :---------- | :---------: | :------------------------------ | | DIRECTORY_NAME | string | Full path to the directory you wish to create |

mtime

↑ back to method list

  • Syntax:
ns.mtime(NETSTORAGE_PATH, UNIX_TIME, callback(err, response, body))
  • Parameters:

    | Name | Type | Description | | :---------- | :---------: | :------------------------------ | | NETSTORAGE_PATH | string | full path to the file/directory | | UNIX_TIME | integer | Unix time to set the mtime of the file to. Note that millisecond accuracy is not supported |

quick_delete

↑ back to method list

  • Syntax:
ns.quick_delete(NETSTORAGE_DIR, callback(err, response, body)) // needs to be enabled on the CP Code
  • Parameters:

    | Name | Type | Description | | :---------- | :---------: | :------------------------------ | | NETSTORAGE_DIR | string | full path to the directory you wish to delete|

rename

↑ back to method list

  • Syntax:
ns.rename(NETSTORAGE_TARGET, NETSTORAGE_DESTINATION, callback(err, response, body))
  • Parameters:

    | Name | Type | Description | | :---------- | :---------: | :------------------------------ | | NETSTORAGE_TARGET | string | full path to the original file/directory | | NETSTORAGE_DESTINATION | string | full path to the renamed file/directory |

rmdir

↑ back to method list

  • Syntax:
ns.rmdir(NETSTORAGE_DIR, callback(err, response, body))
  • Parameters:

    | Name | Type | Description | | :---------- | :---------: | :------------------------------ | | NETSTORAGE_DIR | string | full path to the empty object you wish to delete |

stat

↑ back to method list

  • Syntax:
ns.stat(NETSTORAGE_PATH, callback(err, response, body))
  • Parameters:

    | Name | Type | Description | | :---------- | :---------: | :------------------------------ | | NETSTORAGE_PATH | string | full path to the file/directory you wish to stat |

symlink

↑ back to method list

  • Syntax:
ns.symlink(NETSTORAGE_SOURCE, NETSTORAGE_TARGET, callback(err, response, body))
  • Parameters:

    | Name | Type | Description | | :---------- | :---------: | :------------------------------ | | NETSTORAGE_SOURCE | string | full path to the original file | | NETSTORAGE_TARGET | string | full path of the new symlinked file to create |

upload

↑ back to method list

  • Syntax:
ns.upload(LOCAL_SOURCE, NETSTORAGE_DESTINATION, callback(err, response, body))
  • Parameters:

    | Name | Type | Description | | :---------- | :---------: | :------------------------------ | | LOCAL_SOURCE | string | Path to the local file you wish to upload | | NETSTORAGE_DESTINATION | string | Path to the location you wish to upload the file. Note that if you omit the actual filename, the source filename is used. You may only upload files using the API, not directories. |

Testing

Unit tests for all of the above methods are executed via the test script. Prior to testing, create an api-config.json file in the test directory using the provided example for the required values. The excellent Mocha and ChaiJS libraries are used for all tests:

$ npm install --global mocha chai
$ npm test # use test/api-config.json

Author

Astin Choi ([email protected])

License

Copyright 2016 Akamai Technologies, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.