Skip to main content

​
Installation

Install the Inspatial Cloud Client SDK using your preferred package manager.

​
Package Managers

npm install @inspatial/cloud-client

​
Deno

For Deno projects, import directly from JSR or npm: 
import { InCloudClient, InLiveClient } from "jsr:@inspatial/cloud-client";
The SDK requires TypeScript 4.5+ for optimal type inference and supports modern ES modules.

​
Available Exports

The SDK provides the following main exports: 
import {
  InCloudClient,  // REST API client
  InLiveClient,   // WebSocket real-time client
  MimeTypes,      // MIME type utilities
  Currencies      // Currency type definitions
} from '@inspatial/cloud-client';

// Type definitions available from subpath
import type { Entry, EntryType, InField } from '@inspatial/cloud-client/types';

​
TypeScript Configuration

For the best development experience, ensure your tsconfig.json includes:
tsconfig.json
{
  "compilerOptions": {
    "lib": ["dom", "dom.iterable", "esnext"],
    "module": "esnext",
    "moduleResolution": "bundler",
    "target": "esnext",
    "strict": true
  }
}

​
Verify Installation

Verify the installation by importing the clients: 
import { InCloudClient, InLiveClient } from '@inspatial/cloud-client';

console.log(InCloudClient); // [class InCloudClient]
console.log(InLiveClient);  // [class InLiveClient]

​
Next Steps

Quickstart Guide

Follow the quickstart guide to create your first integration

Build docs developers (and LLMs) love

Get started for freeTalk to us