RequirementsUse of the Square Node.js SDK requires:
- Node.js 14 or higher
This SDK supports Node.js versions that are either current, or that are in long-term support status (LTS). The SDK does not support Node.js versions that have reached their end-of-life (EOL). For more information on Node.js versioning, see .
This SDK is for use with Node.js only. It does not support other usages, such as for web browsers or frontend applications.
InstallationFor more information, see Set Up Your Square SDK for a Node.js Project.
QuickstartFor more information, see Square Node.js SDK Quickstart.
UsageFor more information, see Using the Square Node.js SDK.
TestsFirst, clone the repo locally and
cdinto the directory.
git clone https://github.com/square/square-nodejs-sdk.git cd square-nodejs-sdk
Next, install dependencies and build.
npm install npm run build
Before running the tests, get a sandbox access token from your Developer Dashboard and use it to set a
export SQUARE_SANDBOX_TOKEN="YOUR SANDBOX ACCESS TOKEN HERE"
And run the tests.