Amplitude-TypeScript

This is Amplitude's latest version of the JavaScript SDK, written in TypeScript.

Development

If you plan on contributing to this SDK, here's how you can start.

1. Clone GitHub repo
2. Install dependencies
3. Build and link packages

$ git clone git@github.com:amplitude/Amplitude-TypeScript.git
$ nvm use
$ pnpm --version
$ pnpm install
$ pnpm build

Check our guidelines for repo contributions on CONTRIBUTING.md.

Projects

• Amplitude SDK for Web
  • @amplitude/analytics-browser@^2
  • @amplitude/analytics-browser@^1
  • Installation and Quick Start
• Amplitude SDK for Node.js
  • @amplitude/analytics-node
  • Installation and Quick Start
• Amplitude SDK for React Native
  • @amplitude/analytics-react-native
  • Installation and Quick Start

Testing Locally

To test the SDK locally, you can run our test server.

Before running the test server for the first time, copy ".env.example" as ".env" and replace the variables in '.env' with your own variables.

Run pnpm dev to run the test server. It will open up to the home page automatically in your default browser.

For more details visit the Test Server README.md

Troubleshooting

If you ever see an error that looks like this while running an Nx command (pnpm test, pnpm build, etc...):

 Lerna (powered by Nx)   DB transaction operation error: SqliteFailure(Error { code: SystemIoFailure, extended_code: 522 }, Some("disk I/O error"))

Run npx nx reset and try again

Documentation

See our Typescript SDK Reference for a list and description of all available SDK methods.