Skip to content

API reference / @chanx-js/codegen / analyze

Function: analyze() ​

ts
function analyze(document): ConnectionInfo[];

Defined in: analyze.ts:100

Split channels into connections and the topics riding on them.

A topic channel shares its connection's address, which is what groups the two; chanx's own Python generator uses the same rule. With no plain channel at its address, a hosted topic gets a connection named after its host, carrying no messages itself; a topic served on its own route is emitted as both.

Parameters ​

ParameterType
documentAsyncAPIDocument

Returns ​

ConnectionInfo[]

MIT licensed