API概要

Trace Kernelは、workから利用できる独自APIを提供します。

contextはワークスペースで定義した内容によって変わります。一方、APIはTrace Kernelが実行環境として提供する機能です。

標準API
├── $print / $println
├── $channel
├── $state
├── $parser
└── $runtime

contextとの違い

contextは、ユーザーがワークスペースに登録した情報です。

$env.OUTPUT_DIR
$resource.userData
$dataset.workspace

APIは、Trace Kernelの実行環境が提供する操作能力です。

$println('hello');
const { tick } = $state.useProgress(100);

この2つは役割が異なるため、リファレンス上も分けて扱います。

出力方式とAPI

workのoutput_methodにより、出力用APIが変わります。

output_method	利用できる出力API	用途
Plain	$print / $println	シンプルなテキスト出力
Channel	$channel	複数ストリーム、テーブル出力

$state、$parser、$runtimeは、出力方式とは別に利用するAPIです。

Pro API

ファイル操作やネットワークアクセスのようにTrace Kernelの外側へ作用するAPIは、Pro配下で扱います。