Documentation Index
Fetch the complete documentation index at: https://docs.bitfield.so/llms.txt
Use this file to discover all available pages before exploring further.
Reference
Runtime Kit API.
The current public JavaScript Runtime Kit API exposes one request function and one React read hook.
Public imports
import {
sendRequestToBitfieldTarget,
type BitfieldTargetReply,
type BitfieldTargetRequest,
} from '@bitfield/runtime-kit';
import { useBitfieldData } from '@bitfield/runtime-kit/react';
@bitfield/runtime-kit. The React hook exports the hook value only.sendRequestToBitfieldTarget(...)
function sendRequestToBitfieldTarget(
request: BitfieldTargetRequest,
signal?: AbortSignal,
): Promise<BitfieldTargetReply>;
Request
type BitfieldTargetRequest = {
target: string;
payload?: unknown;
};
| Field | Required | Meaning |
|---|
target | yes | Public name of the callable target. |
payload | no | Data sent to the target. Runtime Kit turns it into bytes. |
Reply
type BitfieldTargetReply = {
payload: Uint8Array;
};
Payload conversion
| Input | Sent as |
|---|
Uint8Array | The same bytes. |
string | Text bytes. |
| Any other JSON-compatible value | JSON bytes. |
| omitted | Empty bytes. |
Errors
The function throws an Error if the request cannot complete. App code should catch errors at user-action boundaries and render a recoverable state.Guide
Read Send a request for examples and patterns.useBitfieldData(...)
function useBitfieldData<T>(
selector?:
| string
| {
input?: string;
params?: Record<string, unknown>;
},
): {
data: T | null;
loading: boolean;
error: Error | null;
};
Return value
| Field | Meaning |
|---|
data | The current prepared value, or null if no value is ready. |
loading | true while Runtime Kit is preparing or waiting for the value. |
error | The read error, or null when no error exists. |
| Selector | Meaning |
|---|
| omitted | Read the default prepared input for this surface. |
| string | Read a named prepared input. |
object with input and params | Read a named or selected input with local selection params. |
Guide
Read Read data in React for component examples and common mistakes.Public versus private
| Public app code may use | App code should not use |
|---|
@bitfield/runtime-kit | Unpublished Runtime Kit source paths. |
@bitfield/runtime-kit/react | Private setup or low-level Runtime Kit machinery. |
sendRequestToBitfieldTarget(...) | Direct imports of the target implementation. |
useBitfieldData(...) | Hand-built storage addresses or package parsing inside components. |
Version note
This page documents the current public JavaScript surface. If the package exports change, this reference and the Runtime Kit guides must be reviewed together.
