Methods
to
Staticcapture
- capture
Stack Trace(targetObject, constructorOpt?): void Create .stack property on a target object
diff --git a/docs/classes/_bunny_net_edgescript_sdk_latest.net.socketAddr.InvalidAddr.html b/docs/classes/_bunny_net_edgescript_sdk_latest.net.socketAddr.InvalidAddr.html new file mode 100644 index 0000000..56b2392 --- /dev/null +++ b/docs/classes/_bunny_net_edgescript_sdk_latest.net.socketAddr.InvalidAddr.html @@ -0,0 +1,15 @@ +InvalidAddr | Edge Script SDK Documentation \ No newline at end of file diff --git a/docs/functions/_bunny_net_edgescript_sdk_latest.net.http.serve.html b/docs/functions/_bunny_net_edgescript_sdk_latest.net.http.serve.html new file mode 100644 index 0000000..98b6412 --- /dev/null +++ b/docs/functions/_bunny_net_edgescript_sdk_latest.net.http.serve.html @@ -0,0 +1,2 @@ +Class InvalidAddr
Hierarchy
- Error
- InvalidAddr
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Invalid Addr(message): net.socketAddr.InvalidAddr Parameters
- message: string
Returns net.socketAddr.InvalidAddr
Properties
_guard
_guard: symbol = addr_symbolOptionalcausecause?: unknownmessage
message: stringname
name: stringOptionalstackstack?: stringStaticOptionalprepareStack Trace prepareStack Trace?: ((err: Error, stackTraces: CallSite[]) => any) Optional override for formatting stack traces
+StaticstackTrace Limit stackTrace Limit: number serve | Edge Script SDK Documentation \ No newline at end of file diff --git a/docs/functions/_bunny_net_edgescript_sdk_latest.net.http.servePullZone.html b/docs/functions/_bunny_net_edgescript_sdk_latest.net.http.servePullZone.html new file mode 100644 index 0000000..b0e5b89 --- /dev/null +++ b/docs/functions/_bunny_net_edgescript_sdk_latest.net.http.servePullZone.html @@ -0,0 +1,4 @@ +Function serve
- serve(handler): net.http.ServeHandler
Serves HTTP requests with the provided handler.
+Parameters
- handler: net.http.ServerHandler
Returns net.http.ServeHandler
- serve(listener, handler): net.http.ServeHandler
Parameters
- listener: {
hostname: string;
port: number;
}hostname: string
port: number
- handler: net.http.ServerHandler
Returns net.http.ServeHandler
- listener: {
- serve(listener, handler): net.http.ServeHandler
Parameters
- listener: net.tcp.TcpListener
- handler: net.http.ServerHandler
Returns net.http.ServeHandler
servePullZone | Edge Script SDK Documentation \ No newline at end of file diff --git a/docs/functions/_bunny_net_edgescript_sdk_latest.net.ip.toString.html b/docs/functions/_bunny_net_edgescript_sdk_latest.net.ip.toString.html new file mode 100644 index 0000000..e8e42d6 --- /dev/null +++ b/docs/functions/_bunny_net_edgescript_sdk_latest.net.ip.toString.html @@ -0,0 +1 @@ +Function servePullZone
- serve
Pull Zone(options): net.http.PullZoneHandler Serves HTTP requests for a PullZone
+If you have an associated PullZone within Bunny, we'll use it on production +and for local development you can configure it with the
+urloption.Parameters
- options: net.http.PullZoneHandlerOptions
Returns net.http.PullZoneHandler
- serve
Pull Zone(listener, options): net.http.PullZoneHandler Parameters
- listener: {
hostname: string;
port: number;
}hostname: string
port: number
- options: net.http.PullZoneHandlerOptions
Returns net.http.PullZoneHandler
- listener: {
- serve
Pull Zone(listener, options): net.http.PullZoneHandler Parameters
- listener: net.tcp.TcpListener
- options: net.http.PullZoneHandlerOptions
Returns net.http.PullZoneHandler
toString | Edge Script SDK Documentation \ No newline at end of file diff --git a/docs/functions/_bunny_net_edgescript_sdk_latest.net.ip.tryParseFromString.html b/docs/functions/_bunny_net_edgescript_sdk_latest.net.ip.tryParseFromString.html new file mode 100644 index 0000000..c8ce0e3 --- /dev/null +++ b/docs/functions/_bunny_net_edgescript_sdk_latest.net.ip.tryParseFromString.html @@ -0,0 +1,2 @@ + tryParseFromString | Edge Script SDK Documentation \ No newline at end of file diff --git a/docs/functions/_bunny_net_edgescript_sdk_latest.net.socketAddr.isV4.html b/docs/functions/_bunny_net_edgescript_sdk_latest.net.socketAddr.isV4.html new file mode 100644 index 0000000..05654a1 --- /dev/null +++ b/docs/functions/_bunny_net_edgescript_sdk_latest.net.socketAddr.isV4.html @@ -0,0 +1,2 @@ +isV4 | Edge Script SDK Documentation \ No newline at end of file diff --git a/docs/functions/_bunny_net_edgescript_sdk_latest.net.socketAddr.v4.ip.html b/docs/functions/_bunny_net_edgescript_sdk_latest.net.socketAddr.v4.ip.html new file mode 100644 index 0000000..939fee4 --- /dev/null +++ b/docs/functions/_bunny_net_edgescript_sdk_latest.net.socketAddr.v4.ip.html @@ -0,0 +1,2 @@ +Function isV4
- is
V4(value): value is net.socketAddr.v4.SocketAddrV4 Tell if it's a v4 [SocketAddr].
+Parameters
- value: net.socketAddr.SocketAddr
Returns value is net.socketAddr.v4.SocketAddrV4
ip | Edge Script SDK Documentation \ No newline at end of file diff --git a/docs/functions/_bunny_net_edgescript_sdk_latest.net.socketAddr.v4.port.html b/docs/functions/_bunny_net_edgescript_sdk_latest.net.socketAddr.v4.port.html new file mode 100644 index 0000000..80c9203 --- /dev/null +++ b/docs/functions/_bunny_net_edgescript_sdk_latest.net.socketAddr.v4.port.html @@ -0,0 +1,2 @@ +Function ip
- ip(addr): net.ip.IPv4
Returns the IP address associated with this socket address.
+Parameters
- addr: net.socketAddr.v4.SocketAddrV4
Returns net.ip.IPv4
port | Edge Script SDK Documentation \ No newline at end of file diff --git a/docs/functions/_bunny_net_edgescript_sdk_latest.net.socketAddr.v4.tryFromString.html b/docs/functions/_bunny_net_edgescript_sdk_latest.net.socketAddr.v4.tryFromString.html new file mode 100644 index 0000000..087a2a6 --- /dev/null +++ b/docs/functions/_bunny_net_edgescript_sdk_latest.net.socketAddr.v4.tryFromString.html @@ -0,0 +1,2 @@ +Function port
- port(addr): number
Returns the port number associated with this socket address.
+Parameters
- addr: net.socketAddr.v4.SocketAddrV4
Returns number
tryFromString | Edge Script SDK Documentation \ No newline at end of file diff --git a/docs/functions/_bunny_net_edgescript_sdk_latest.net.tcp.bind.html b/docs/functions/_bunny_net_edgescript_sdk_latest.net.tcp.bind.html new file mode 100644 index 0000000..2cef439 --- /dev/null +++ b/docs/functions/_bunny_net_edgescript_sdk_latest.net.tcp.bind.html @@ -0,0 +1,2 @@ +Function tryFromString
- try
From String(value): net.socketAddr.v4.SocketAddrV4 | SyntaxError Try to parse a SocketAddrV4
+Parameters
- value: string
Returns net.socketAddr.v4.SocketAddrV4 | SyntaxError
bind | Edge Script SDK Documentation \ No newline at end of file diff --git a/docs/functions/_bunny_net_edgescript_sdk_latest.net.tcp.isTcpListener.html b/docs/functions/_bunny_net_edgescript_sdk_latest.net.tcp.isTcpListener.html new file mode 100644 index 0000000..4292919 --- /dev/null +++ b/docs/functions/_bunny_net_edgescript_sdk_latest.net.tcp.isTcpListener.html @@ -0,0 +1 @@ +Function bind
- bind(addr): net.tcp.TcpListener
Bind an Addr
+Parameters
- addr: net.socketAddr.v4.SocketAddrV4
Returns net.tcp.TcpListener
isTcpListener | Edge Script SDK Documentation \ No newline at end of file diff --git a/docs/functions/_bunny_net_edgescript_sdk_latest.net.tcp.toString.html b/docs/functions/_bunny_net_edgescript_sdk_latest.net.tcp.toString.html new file mode 100644 index 0000000..5772716 --- /dev/null +++ b/docs/functions/_bunny_net_edgescript_sdk_latest.net.tcp.toString.html @@ -0,0 +1,2 @@ +Function isTcpListener
- is
Tcp Listener(value): value is net.tcp.TcpListener Parameters
- value: unknown
Returns value is net.tcp.TcpListener
toString | Edge Script SDK Documentation \ No newline at end of file diff --git a/docs/functions/_bunny_net_edgescript_sdk_latest.net.tcp.unstable_local_addr.html b/docs/functions/_bunny_net_edgescript_sdk_latest.net.tcp.unstable_local_addr.html new file mode 100644 index 0000000..3a327f4 --- /dev/null +++ b/docs/functions/_bunny_net_edgescript_sdk_latest.net.tcp.unstable_local_addr.html @@ -0,0 +1,2 @@ +Function toString
- to
String(tcp): string Format the associated [TcpListener] to a String
+Parameters
- tcp: net.tcp.TcpListener
Returns string
unstable_local_addr | Edge Script SDK Documentation \ No newline at end of file diff --git a/docs/functions/_bunny_net_edgescript_sdk_latest.net.tcp.unstable_new.html b/docs/functions/_bunny_net_edgescript_sdk_latest.net.tcp.unstable_new.html new file mode 100644 index 0000000..cf543c3 --- /dev/null +++ b/docs/functions/_bunny_net_edgescript_sdk_latest.net.tcp.unstable_new.html @@ -0,0 +1,2 @@ +Function unstable_local_addr
- unstable_
local_ addr(tcp): net.socketAddr.SocketAddr Returns the local socket address of this listener.
+Parameters
- tcp: net.tcp.TcpListener
Returns net.socketAddr.SocketAddr
unstable_new | Edge Script SDK Documentation \ No newline at end of file diff --git a/docs/images/bunny.png b/docs/images/bunny.png deleted file mode 100644 index 7187c74..0000000 Binary files a/docs/images/bunny.png and /dev/null differ diff --git a/docs/index.html b/docs/index.html index ed3af59..4190297 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,33 +1,23 @@Function unstable_new
- unstable_
new(): net.tcp.TcpListener Create a new [TcpListener].
+Returns net.tcp.TcpListener
Edge Script SDK Documentation \ No newline at end of file +Edge Script SDK Documentation
-Bunny - edgescript-sdk
This repository contains one library for now: the
-@bunny.net/edgescript-sdk-which is a little lib which intend to help you develop applications running -over Bunny.We choose to run Bunny Scripts with a Deno modified runtime that leverage our -networks and products. To be able to also develop locally as if you were inside -the Bunny Network, we are creating a library which will help you leveraging your -prefered Javascript/Typescript environment locally and benefit from the Bunny -Network for your deployed script.
+Bunny.net - edgescript-sdk
This repository contains SDK to enable local development of Bunny.net Edge Scripting:
+@bunny.net/edgescript-sdkBunny.net Edge Scripting is built with a custom Deno runtime that runs on the Bunny.net Edge Scripting. +This SDK provides similar environment to Bunny.net Edge Scripting locally, +so that you can run and debug scripts in your local environment before publishing them.
Even if the Bunny Runtime is very similar to the Deno & Node Runtime, some API -might differ or not being available due to the fact we leverage our network +might differ or not being available due to the fact we leverage our CDN and run scripts in a serverless environment.
-We also have a roadmap and some items are just not priorized yet, if you want -to have those available, reach out to us any times!
Usage
With
@bunny.net/edgescript-sdkyou can write a script which will work with Deno, with Node, and within our network.
-import * as BunnySDK from "@bunny.net/edgescript-sdk";
function sleep(ms: number): Promise<void> {
return new Promise((resolve) => setTimeout(resolve, ms));
}
console.log("Starting server...");
BunnySDK.net.http.serve({ port: 8080, hostname: '127.0.0.1' }, async (req) => {
console.log(`[INFO]: ${req.method} - ${req.url}`);
await sleep(1);
return new Response("blbl");
});If you execute this code on a deployed Bunny Script, the serve function will -always be used to allow requests that goes from your PullZone (let's assume you -have
-https://domain-test.b-cdn.netas a PullZone).In this case, every curl request to
-https://domain-test.b-cdn.netwill be -redirect to the associated Bunny Script.You have a full list of examples in the example folder you can -use.
-If you execute this code on a deployed Bunny.net Edge Scripting script, the serve function will +be used to execute requests on a connected PullZone.
+Full list of examples is in the example folder.
+- Error
+ 
Optional override for formatting stack traces
+