| name | factory-function-composition |
| description | Factory function patterns to compose clients and services. Use when wrapping resources with domain methods or refactoring mixed client/service/method options. |
| metadata | {"author":"epicenter","version":"1.0"} |
Factory Function Composition
This skill helps you apply factory function patterns for clean dependency injection and function composition in TypeScript.
Related Skills: See method-shorthand-jsdoc for when to move helpers into the return object. See refactoring for caller counting and inlining single-use extractions.
When to Apply This Skill
Use this pattern when you see:
- A function that takes a client/resource as its first argument
- Options from different layers (client, service, method) mixed together
- Client creation happening inside functions that shouldn't own it
- Functions that are hard to test because they create their own dependencies
The Universal Signature
Every factory function follows this signature:
function createSomething(dependencies, options?) {
return {
};
}
- First argument: Always the resource(s). Either a single client or a destructured object of multiple dependencies.
- Second argument: Optional configuration specific to this factory. Never client config; that belongs at client creation.
Two arguments max. First is resources, second is config. No exceptions.
The Core Pattern
function createService(client, options = {}) {
return {
method(methodOptions) {
},
};
}
function createService({ db, cache }, options = {}) {
return {
method(methodOptions) {
},
};
}
const client = createClient(clientOptions);
const service = createService(client, serviceOptions);
service.method(methodOptions);
Key Principles
- Client configuration belongs at client creation time: don't pipe clientOptions through your factory
- Each layer has its own options: client, service, and method options stay separate
- Dependencies come first: factory functions take dependencies as the first argument
- Return objects with methods: not standalone functions that need the resource passed in
Recognizing the Anti-Patterns
Anti-Pattern 1: Function takes client as first argument
function doSomething(client, options) { ... }
doSomething(client, options);
const service = createService(client);
service.doSomething(options);
Anti-Pattern 2: Client creation hidden inside
function doSomething(clientOptions, methodOptions) {
const client = createClient(clientOptions);
}
const client = createClient(clientOptions);
const service = createService(client);
service.doSomething(methodOptions);
Anti-Pattern 3: Mixed options blob
doSomething({
timeout: 5000,
retries: 3,
endpoint: '/users',
payload: data,
});
const client = createClient({ timeout: 5000, retries: 3 });
const service = createService(client);
service.doSomething({ endpoint: '/users', payload: data });
Anti-Pattern 4: Multiple layers hidden
function doSomething(clientOptions, serviceOptions, methodOptions) {
const client = createClient(clientOptions);
const service = createService(client, serviceOptions);
return service.method(methodOptions);
}
const client = createClient(clientOptions);
const service = createService(client, serviceOptions);
service.method(methodOptions);
Multiple Dependencies
When your service needs multiple clients:
function createService(
{ db, cache, http },
options = {},
) {
return {
method(methodOptions) {
},
};
}
const db = createDbConnection(dbOptions);
const cache = createCacheClient(cacheOptions);
const http = createHttpClient(httpOptions);
const service = createService({ db, cache, http }, serviceOptions);
service.method(methodOptions);
The Canonical Internal Shape
The previous sections cover the external signature: (deps, options?) → return { methods }. This section covers what goes inside the function body. Every factory function follows a four-zone ordering:
function createSomething({ db, cache }: Deps, options?) {
const maxRetries = options?.maxRetries ?? 3;
}
function createSomething(deps: Deps, options?) {
const { db, cache } = deps;
const maxRetries = options?.maxRetries ?? 3;
}
Both are valid. The point is that by the time you reach zone 2, all dependencies and config are bound to const names. The four zones:
function createSomething({ db, cache }, options?) {
const maxRetries = options?.maxRetries ?? 3;
let connectionCount = 0;
let lastError: Error | null = null;
function resetState() {
connectionCount = 0;
lastError = null;
}
return {
connect() { ... },
disconnect() { ... },
get errorCount() { return connectionCount; },
};
}
Zones 1 and 2 can merge when there's little state. Zone 3 is empty for small factories. But the return object is always last: it's the complete public API.
Public Return Types Derive From Zone 4
When the exported type is just the handle returned by one factory, derive the type from the factory instead of annotating the factory with the type.
export type RemoteClient = ReturnType<typeof createRemoteClient>;
export function createRemoteClient(options: RemoteClientOptions) {
return {
actions<T>(peerId: string): RemoteActionProxy<T> {
},
describe(peerId: string): Promise<ActionManifest> {
},
};
}
Zone 4 is already the public API. Duplicating it in a manual return type creates a second source of truth and changes editor navigation: Go to Definition tends to jump to the alias instead of the returned member. Keep method parameter and return annotations inside zone 4 when they make the public surface clearer.
This is one face of a broader principle: when organizing types and exports, always consider Go-to-Definition. Adapter / proxy / wrapper factories with no behavior change are another regression in the same family: Go-to-Def lands on the wrapper instead of the source of truth. The "collapsed adapter" rule below is its concrete remedy. See typescript "Go-to-Definition Awareness" for the full set of regressions to watch for, and method-shorthand-jsdoc for the JSDoc sibling of this navigation concern.
Do not use this for shared service contracts that several factories implement. Those contracts are vocabulary. Use satisfies at the return object when a factory needs to prove it matches an external contract while preserving the concrete returned shape.
The this Decision Rule
Inside the return object, public methods sometimes need to call other public methods. Use this.method() for that; method shorthand gives proper this binding.
If a function is called both by return-object methods and by pre-return initialization logic, it belongs in zone 3 (private helpers). Call it directly by name; no this needed.
| Where the function lives | How to call it |
|---|
| Return object (zone 4) | this.method() from sibling methods |
| Private helper (zone 3) | Direct call by name: helperFn() |
| Both zones need it | Keep in zone 3, call by name everywhere |
See Closures Are Better Privacy Than Keywords for the full rationale and real codebase examples.
Structural Contracts: Factories That Satisfy External Interfaces
A factory's return object can be designed to structurally satisfy an external contract, so it can be passed directly to a platform-agnostic core without an adapter.
The canonical example is createPersistedState / createStorageState, whose return shape structurally satisfies the SessionStore contract that @epicenter/auth's createAuth consumes:
type SessionStore = {
get(): T | null;
set(value: T | null): void;
watch(fn: (next: T | null) => void): () => void;
};
function createPersistedState(opts) {
let value = $state(readFromStorage());
return {
get current() { return value },
set current(v) { setAndPersist(v) },
get(): T { return value },
set: setAndPersist,
watch(fn) { },
};
}
const session = createPersistedState({ key, schema, defaultValue });
const auth = createAuth({ baseURL, session });
The "collapsed adapter" rule
If you find yourself writing a fromX translator that only renames or re-projects fields, delete it and widen the factory's return shape instead. The adapter is pure ceremony; the factory already holds the state, so just expose both surfaces.
Signs an adapter should be collapsed:
- It's one-to-one with the factory (every caller wraps the factory result).
- It only renames methods or adds a thin passthrough.
- The factory and the contract disagree on shape but not on semantics (
.current vs .get(): same value, different API).
Signs an adapter should stay:
- It does real work at the seam (e.g., sync-read-vs-async-get reconciliation, local-write fan-out because the underlying
watch only fires on external change).
- Multiple consumers with different contracts wrap the same factory.
When in doubt: start without the adapter. Add one only when the seam actually earns its keep.
Why this works
TypeScript's structural typing means the factory doesn't have to implements SessionStore or import the contract type. As long as the return shape matches, it's assignable. This keeps the factory package free of the consumer's dependencies: createPersistedState lives in @epicenter/svelte and has zero knowledge of @epicenter/auth.
The Mental Model
Think of it as a chain where each link:
- Receives a resource from the previous link
- Adds its own configuration
- Produces something for the next link
createClient(...) → createService(client, ...) → service.method(...)
↑ ↑ ↑
clientOptions serviceOptions methodOptions
Benefits
- Testability: Inject mock clients easily
- Reusability: Share clients across multiple services
- Flexibility: Configure each layer independently
- Clarity: Clear ownership of configuration at each level
References
See the full articles for more details:
Load on demand: