stitch() & the builder

The authoring surface: the four exports that produce a stitch, plus the fluent builder they share. For what goes inside the config object, see Reference → Config types.

stitch()

stitch<T>(config) takes a path string or a partial config and returns a Stitch<T>; stitch.use(...) starts the fluent builder instead.

import { stitch } from 'stitchapi';

const user = stitch<{ id: string }>({
    path: 'https://api.example.com/me',
});

defineStitch()

defineStitch(...fragments) binds shared base fragments and returns a stitch() factory; each call deep-merges the bound fragments under the per-call config.

import { defineStitch } from 'stitchapi';

const api = defineStitch({ path: 'https://api.example.com' });
const user = api<{ id: string }>('/me');

preset()

preset(cfg) is an identity-tagged fragment — a named bundle of reusable defaults you pass through extends. It returns the same Partial<StitchConfig>.

import { preset } from 'stitchapi';

const base = preset({ retry: { attempts: 3 } });

graphql()

graphql<T>(config) is a stitch preset for GraphQL-over-HTTP: it POSTs { query, variables } and unwraps data. The config must carry a query.

import { graphql } from 'stitchapi';

const viewer = graphql<{ viewer: { id: string } }>({
    path: 'https://api.example.com/graphql',
    query: 'query { viewer { id } }',
});

See Guide → graphql for usage.

The fluent builder

stitch.use(...) returns a Builder: a callable object whose chainable methods accumulate config, then resolve to a stitch when you call it (or .stream() / .with()).

import { stitch } from 'stitchapi';

const user = stitch.use().get('https://api.example.com/me');

See also