TypeScript SDK
Install and start using the TypeScript SDK.
Intro
The SentimentScan API SDK provides access to the SentimentScan API REST APIs.
Lexicon-based sentiment analysis for short texts. Returns a polarity score from -1 (negative) to +1 (positive), a label, and per-word drivers.
Installation
The SDK compiles to dist/ before it can be referenced — run its build script once in the SDK folder, then add it to your project by path:
npm install <path-to-sdk>Quick Start
Create one client and reuse it. Configure its behaviour through ClientOptions.
import { SentimentScanApiClient } from "sentiment-scan-api";
const client = new SentimentScanApiClient({});Nothing in ClientOptions is required — new SentimentScanApiClient() compiles — and each option left out falls back to its default. This API declares one environment, so there is no environment to select and no host to state at the construction site.
From CommonJS
The package ships both dialects from a single entry, so require works with full types. In a TypeScript CommonJS file use the import ... = require(...) form — a plain destructuring require runs fine but gives you any.
import sdk = require("sentiment-scan-api");
const client = new sdk.SentimentScanApiClient({});