Nonlinear Performance Magnification
    Wondering what’s next for npm?Check out our public roadmap! »

    uplink-nodejs
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.6 • Public • Published

    uplink-nodejs binding

    Codacy Badge

    Developed using v1.2.2 storj/uplink-c

    API documentation and tutorial

    Initial Set-up (Important)

    For Golang

    • Make sure your PATH includes the $GOPATH/bin directory, so that your commands can be easily used Refer: Install the Go Tools:

      export PATH=$PATH:$GOPATH/bin
      
    • Install node-gyp globally

    $ npm install -g node-gyp
    
    • Install the storj-nodejs Node.js package
    $ npm install uplink-nodejs
    
    • Set Environment variable
      • MacOS
        • Set DYLD_LIBRARY_PATH environment variable
          • Run following command inside root directory of your project
            export  DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$PWD/node_modules/uplink-nodejs/
            
          OR
        • Copy libuplinkc*.* files from $PROJECTROOT/node_modules/uplink-nodejs/ to /usr/local/lib
      • Windows
        • Set Path environment variable to libuplinkc*.* which is $PROJECTROOT/node_modules/uplink-nodejs

    For NodeJS

    • Please ensure Node.js with version 10 or higher is installed
      • Check Node.js version
        $ node -v
        
    • please ensure make is already installed.
    • please ensure node-gyp dependencies is already installed.
    • please ensure @types/node dependencies is installed for running module in typescript.

    Run Unit Test Cases on Local

    Directory with unit test cases test can be found in the uplink-nodejs repository.

    To run the test cases on a local system, you need to perform the following steps:

    • clone the repo so that you have the test folder on your local system.

        directory_on_local
        └── test
      
    • Add a test file parallel to the tests folder, add API Key in the file, and name it as secret.txt. The directory structure would be something like this now:

        directory_on_local
        └── secret.txt
        └── test
            └── testcase.ts
      
    • Navigate to the folder, here directory_on_local and use the following command to run through all the tests.

            $ npm test
    

    Documentation

    For more information on function definations and diagrams, check out the Detail or jump to:

    Install

    npm i uplink-nodejs

    DownloadsWeekly Downloads

    16

    Version

    1.2.6

    License

    Apache-2.0

    Unpacked Size

    4.1 MB

    Total Files

    884

    Last publish

    Collaborators

    • avatar