66 lines
1.9 KiB
Markdown
66 lines
1.9 KiB
Markdown
---
|
|
tags: api/space-lua
|
|
references:
|
|
- client/space_lua/stdlib/net.ts
|
|
---
|
|
|
|
The `net` namespace provides network and URI access.
|
|
|
|
## Proxy request behavior
|
|
|
|
`net.proxyFetch` sends HTTP requests through the SilverBullet server to avoid browser CORS restrictions; see [[HTTP API]]. Its options table supports `method` (GET by default), `headers`, `body`, and `responseEncoding`. A table body is JSON-encoded automatically.
|
|
|
|
The response table contains `ok`, `status`, `headers`, and `body`. JSON responses are parsed into Lua-compatible values, text and XML responses become strings, other content becomes a byte buffer, and an empty body becomes `nil`.
|
|
|
|
## URI services
|
|
|
|
`net.readURI` and `net.writeURI` dispatch to the best service registered for the URI. Pass `{encoding = "text/markdown"}` to `net.readURI` when a service should force a particular result encoding.
|
|
|
|
<!--#lua spacelua.renderApiDocumentation("net") -->
|
|
## net.proxyFetch
|
|
|
|
`net.proxyFetch(url, options?)`
|
|
|
|
Performs an HTTP request through the SilverBullet server to avoid browser CORS restrictions.
|
|
|
|
**Parameters:**
|
|
|
|
- `url` (`string`) — URL to request.
|
|
- `options?` (`table`) — Optional method, headers, body, and responseEncoding values.
|
|
|
|
**Returns:**
|
|
|
|
- `table` — Response status, headers, decoded body, and ok flag.
|
|
|
|
## net.readURI
|
|
|
|
`net.readURI(uri, options?)`
|
|
|
|
Reads content from a URI using the best matching service.
|
|
|
|
**Parameters:**
|
|
|
|
- `uri` (`string`) — URI to read.
|
|
- `options?` (`table`) — Optional service-specific values such as encoding.
|
|
|
|
**Returns:**
|
|
|
|
- Value — Content returned by the matching service.
|
|
|
|
## net.writeURI
|
|
|
|
`net.writeURI(uri, content)`
|
|
|
|
Writes content to a URI using the best matching service.
|
|
|
|
**Parameters:**
|
|
|
|
- `uri` (`string`) — URI to write.
|
|
- `content` (`string|userdata`) — Text or binary content to write.
|
|
|
|
**Returns:**
|
|
|
|
- Value — Result returned by the matching service.
|
|
<!--/lua-->
|
|
|