J · Built-in API

On this page

Every signature below comes from the current compiler’s public API. Overloads share a heading. BYREF requires exclusive writable access; TAKE transfers ownership; FAILS lists checked errors. See the teaching chapters and library references for behavior and examples.

JOIN

FUNCTION JOIN(parts AS LIST OF STRING, separator AS STRING) AS STRING

JoinURLPath

FUNCTION JoinURLPath(BYVAL base AS URL,path AS STRING,Query AS LIST OF URLParameter) AS URL FAILS UrlError
FUNCTION JoinURLPath(base AS STRING,path AS STRING,Query AS LIST OF URLParameter) AS STRING FAILS UrlError
FUNCTION JoinURLPath(base AS STRING,path AS STRING,Query AS DICT OF STRING TO STRING) AS STRING FAILS UrlError
FUNCTION JoinURLPath(base AS STRING,path AS STRING,Query AS DICT OF STRING TO LIST OF STRING) AS STRING FAILS UrlError
FUNCTION JoinURLPath(BYVAL base AS URL,path AS STRING,Query AS DICT OF STRING TO STRING) AS URL FAILS UrlError
FUNCTION JoinURLPath(BYVAL base AS URL,path AS STRING,Query AS DICT OF STRING TO LIST OF STRING) AS URL FAILS UrlError
FUNCTION JoinURLPath(base AS STRING,path AS STRING) AS STRING FAILS UrlError
FUNCTION JoinURLPath(BYVAL base AS URL,path AS STRING) AS URL FAILS UrlError

JsonArray

FUNCTION JsonArray(values AS LIST OF JsonValue) AS JsonValue
FUNCTION JsonArray() AS JsonValue

JsonAt

FUNCTION JsonAt(value AS JsonValue,index AS INTEGER) AS JsonValue FAILS JsonError

JsonBoolean

FUNCTION JsonBoolean(value AS BOOLEAN) AS JsonValue

JsonCodec

FUNCTION JsonCodec(Pretty AS BOOLEAN=FALSE,Indent AS INTEGER=2,MaxDepth AS INTEGER=32,MaxInputBytes AS INTEGER=8388608,MaxOutputBytes AS INTEGER=8388608,IgnoreUnknown AS BOOLEAN=FALSE) AS JsonCodec

JsonField

FUNCTION JsonField[T](name AS STRING,value AS T) AS JsonMember FAILS LIKE ToJSON(AS T)
FUNCTION JsonField(name AS STRING,BYVAL value AS JsonValue) AS JsonMember

JsonGetArray

FUNCTION JsonGetArray(value AS JsonValue) AS LIST OF JsonValue FAILS JsonError

JsonGetBoolean

FUNCTION JsonGetBoolean(value AS JsonValue) AS BOOLEAN FAILS JsonError

JsonGetDouble

FUNCTION JsonGetDouble(value AS JsonValue) AS DOUBLE FAILS JsonError

JsonGetInteger

FUNCTION JsonGetInteger(value AS JsonValue) AS INTEGER FAILS JsonError

JsonGetObject

FUNCTION JsonGetObject(value AS JsonValue) AS DICT OF STRING TO JsonValue FAILS JsonError

JsonGetString

FUNCTION JsonGetString(value AS JsonValue) AS STRING FAILS JsonError

JsonGetUInt64

FUNCTION JsonGetUInt64(value AS JsonValue) AS UINT64 FAILS JsonError

JsonLinesReader

FUNCTION JsonLinesReader() AS JsonLinesReader

JsonNull

FUNCTION JsonNull() AS JsonValue

JsonNumber

FUNCTION JsonNumber(text AS STRING) AS JsonValue FAILS JsonError
FUNCTION JsonNumber(value AS INTEGER) AS JsonValue
FUNCTION JsonNumber(value AS UINT64) AS JsonValue
FUNCTION JsonNumber(value AS DOUBLE) AS JsonValue FAILS JsonError

JsonNumberText

FUNCTION JsonNumberText(value AS JsonValue) AS STRING FAILS JsonError

JsonObject

FUNCTION JsonObject(values AS DICT OF STRING TO JsonValue) AS JsonValue
FUNCTION JsonObject() AS JsonValue
FUNCTION JsonObject(members AS LIST OF JsonMember) AS JsonValue

JsonPointer

FUNCTION JsonPointer(path AS STRING,key AS STRING) AS STRING

JsonPut

FUNCTION JsonPut(BYREF object AS JsonValue,key AS STRING,BYVAL value AS JsonValue) AS BOOLEAN FAILS JsonError
FUNCTION JsonPut[T](BYREF object AS JsonValue,key AS STRING,value AS T) AS BOOLEAN FAILS JsonError,LIKE ToJSON(AS T)

JSONResponse

FUNCTION JSONResponse[T](value AS T,status AS INTEGER,headers AS LIST OF HTTPHeader,codec AS JsonCodec) AS HTTPResponse FAILS HTTPError,JsonError,LIKE codec, LIKE __JsonEncodeErrors(AS T)
FUNCTION JSONResponse[T](value AS T,status AS INTEGER,codec AS JsonCodec) AS HTTPResponse FAILS HTTPError,JsonError,LIKE codec, LIKE __JsonEncodeErrors(AS T)
FUNCTION JSONResponse[T](value AS T,status AS INTEGER=200) AS HTTPResponse FAILS HTTPError,JsonError,LIKE __JsonEncodeErrors(AS T)

JsonString

FUNCTION JsonString(value AS STRING) AS JsonValue

JsonTypeSchema

FUNCTION JsonTypeSchema[T](witness AS OPTIONAL OF T) AS TypeGraph

Find your way around BASIL

Type to search the manual.