Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
node_modules/
build/
docs/
.vscode/settings.json
.vscode

# Using pnpm
package-lock.json

# FastEdge debugger artifacts
**/.fastedge-debug/
15 changes: 15 additions & 0 deletions docs/INDEX.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# @gcoredev/proxy-wasm-sdk-as Documentation

AssemblyScript SDK for writing proxy-wasm filter plugins that run on the FastEdge CDN platform. Version 1.2.0.

## Documents

| File | Description |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `quickstart.md` | Getting started: project setup, `asconfig.json` build configuration, hello-world CDN filter example, building to WebAssembly |
| `SDK_API.md` | Complete API reference: proxy-wasm lifecycle (`RootContext`/`Context`), lifecycle hooks, return enums, header/body/property manipulation, FastEdge host APIs (env vars, secrets, KV store, runtime utilities) |

## Suggested Reading Order

1. **`quickstart.md`** — Set up a new project, configure the build, and deploy your first CDN filter.
2. **`SDK_API.md`** — Full API reference for all lifecycle hooks, host APIs, and FastEdge extensions once you are ready to build real functionality.
Loading
Loading