Introduction
Typescript SDK for Common Data Model.
Setup Instructions
-
The build process requires PowerShell. Make sure to add Powershell to your PATH -
C:\Windows\System32\WindowsPowerShell\v1.0
-
Install Node.js.
-
To set up debugging in Visual Studio Code, create launch.json configuration with following:
{ "version": "0.2.0", "configurations": [ { "name": "Debug Jest Tests", "type": "node", "request": "launch", "runtimeArgs": [ "--inspect-brk", "--trace-uncaught", "${workspaceRoot}/node_modules/jest/bin/jest.js", "--runInBand" ], "console": "integratedTerminal", "internalConsoleOptions": "neverOpen", "port": 9229 } ] }
You can optionally install Jest Test Explorer to run the tests using an extensible user interface - Test Explorer UI.
Build
-
To download packages and their dependencies type
npm ci
.Note: Use
npm ci
instead ofnpm install
. One of the biggest downside of thenpm install
command is its unexpected behavior that it may mutate thepackage-lock.json
, whereasnpm ci
only uses the version in the lockfile and produces an error if thepackage-lock.json
andpackage.json
are out of sync. -
To build the project type
npm run build
Unit tests
- To run the unit tests type
npm run test
- A set of Azure Data Lake Storage Gen2 tests are included but disabled by default. To enable them follow the instructions here