SDK

The JS SDK is an npm package that allows you to access linked resources in your functions and frontends in a typesafe way.

Tip

You’ll first need to link a resource to your function or frontend to be able to access it.

Currently, the SDK is only available for JavaScript and TypeScript. Support for other languages is coming soon.

---

Installation

Install the npm package.

npm install sst@ion

Caution

You need the @ion tag to install the Ion version of the SST package.

---

Usage

Import Resource to access the linked resources.

src/lambda.ts

import { Resource } from "sst";

console.log(Resource.MyBucket.name);

Tip

The Resource object is typesafe and will autocomplete the available resources in your editor.

Here we are assuming that a bucket has been linked to the function. Here’s what that could look like.

sst.config.ts

const bucket = new sst.aws.Bucket("MyBucket");

new sst.aws.Function("MyFunction", {
  handler: "src/lambda.handler",
  link: [bucket]
});

---

How it works

In the above example, Resource.MyBucket.name works because it’s been injected into the function package on sst dev and sst deploy.

For functions, this is injected into the globalThis using esbuild and for frontends, it’s injected into the process.env object.

The JS SDK first checks the process.env and then the globalThis for the linked resources. You can read more about how the links are injected.