Skip to main content

Scaffald SDK Documentation

Welcome to the Scaffald SDK documentation! This is the official JavaScript/TypeScript SDK for the Scaffald API.

What is Scaffald SDK?​

The Scaffald SDK is a comprehensive client library that makes it easy to interact with the Scaffald API. It provides:

  • ✅ Type-Safe API Client: Full TypeScript support with generated types
  • ✅ React Integration: Pre-built React hooks powered by TanStack Query
  • ✅ OAuth 2.0 Support: Built-in support for OAuth authentication flows
  • ✅ 34 API Resources: Complete coverage of the Scaffald API
  • ✅ 731+ Tests: Comprehensive test coverage for reliability
  • ✅ Developer-Friendly: Zero configuration, works out of the box

Quick Start​

Install the SDK via npm:

npm install @scaffald/sdk

Basic Usage​

import Scaffald from '@scaffald/sdk';

const client = new Scaffald({
  apiKey: 'your-api-key',
  baseURL: 'https://api.scaffald.com',
});

// List jobs
const jobs = await client.jobs.list();
console.log(jobs.data);

React Integration​

import { useJobs } from '@scaffald/sdk/react';

function JobsList() {
  const { data, isLoading, error } = useJobs();

  if (isLoading) return <div>Loading...</div>;
  if (error) return <div>Error: {error.message}</div>;

  return (
    <div>
      {data.data.map(job => (
        <div key={job.id}>{job.title}</div>
      ))}
    </div>
  );
}

What's Next?​

Getting Help​