Skip to content

Undocumented Request API methods #213

@flaki

Description

@flaki

I noticed a couple inconsistencies between Runnable API and documentationthat I wanted to document below to allow for tracking and further discussions.

  1. There is a variety of set* methods in some languages (e.g. Rust) which are there to enable experimentation with runnables implementing some middleware-functionality. These are intentionally undocumented for now as the API ergonomy and usecases are developed.
  2. In JavaScript the body method returns a JS string. and the bodyBytes method needs to be used to get the raw bytes. Other runtime seem to default to body returning the raw bytes.
  3. The state method in every supported language seem to return the state key value as a string, JavaScript and some other languages also provide a "raw" method (state_raw or stateBytes) to get the raw bytes which is undocumented.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions