@differentialhq/sdk

Typescript SDK

This is the official Differential SDK for Typescript.

Installation

npm

npm install @differentialhq/core

yarn

yarn add @differentialhq/core

pnpm

pnpm add @differentialhq/core

Quick Start

1. Initializing Differential

Create a file named d.ts which will be used to initialize Differential. This file will export the Differential instance.

// d.ts

import { Differential } from "@differentialhq/core";

// Initialize Differential with your API secret.
// Get yours at https://console.differential.dev.
export const d = new Differential("YOUR_API_SECRET");

2. Hello World Service

In a separate file, create the "Hello World" service. This file will import the Differential instance from d.ts and define the service.

// service.ts

import { d } from "./d";

// Define a simple function that returns "Hello, World!"
const sayHello = async ({ to }: { to: string }) => {
  return `Hello, ${to}!`;
};

// ...and as many other functions as you want, any async function can be a service operation
const callEndpoint = async () => {
  return fetch("https://api.example.com");
};

// Create the service
export const helloWorldService = d.service({
  name: "helloWorld",
});

// Register the functions
helloWorldService.register(
  "sayHello",
  getNormalAnimal,
  z.object({ to: z.string() }),
);
helloWorldService.register("callEndpoint", callEndpoint);

3. Running the Service

To run the service, simply run the file with the service definition. This will start the service and make it available to other services.

tsx service.ts

Documentation

• Differential documentation contains all the information you need to get started with Differential.

Examples

• Caching contains an example of how to use Differential's distributed caching.