|
1 | 1 | # @bunny.net/edge-script-sdk |
2 | 2 | --- |
3 | 3 |
|
4 | | -The `@bunny.net/edge-script-sdk` library gives you functions and tools you can |
5 | | -leverage to build scripts and middleware. Those functions are optimized to be |
6 | | -able to run in our Bunny.net Network, but you can also use them to build your |
7 | | -scripts and run it locally with `Node` or `Deno`. |
| 4 | +<div align="center"> |
| 5 | + <a href="https://bunny.net"> |
| 6 | + <img src="https://github.com/BunnyWay/edge-script-sdk/blob/main/asset/bunny.png?raw=true" width="500" height="auto" alt="Bunny"/> |
| 7 | + </a> |
| 8 | +</div> |
8 | 9 |
|
9 | | -## Usage |
| 10 | +# Bunny Edge Scripting SDK |
10 | 11 |
|
11 | | -With `@bunny.net/edgescript-sdk` you can write a script which will work with |
12 | | -Deno, with Node, and within our network. Here is an example with a dynamic http |
13 | | -import you can use with Deno. |
| 12 | +This repository contains `@bunny.net/edgescript-sdk`, a library designed to simplify the development and testing of applications on the Bunny Edge Scripting platform. With this SDK, you can build, debug, and run scripts locally, then deploy them seamlessly to Bunny’s global edge network for production. |
14 | 13 |
|
| 14 | +Under the hood, Bunny Edge Scripting is built on Deno, and includes a custom runtime that supports running scripts interchangeably in both local and Bunny edge environments. This SDK emulates that environment locally, letting you develop and test your scripts with confidence before deploying them. |
| 15 | + |
| 16 | +> **Note:** While the Bunny runtime closely matches Deno and Node behaviors, some APIs may differ or be restricted due to the unique requirements of running applications in a serverless CDN-based environment. |
| 17 | +
|
| 18 | +## 🥕 Usage |
| 19 | + |
| 20 | +With `@bunny.net/edgescript-sdk`, you can write scripts that run smoothly on Deno, Node, and within the bunny.net network. Below is a quick example to help you get started with setting up a local server. For additional examples and use cases, refer to the [examples folder](./example/). |
| 21 | + |
| 22 | +### Hello World Example |
15 | 23 | ```typescript |
16 | | -import * as BunnySDK from "https://esm.sh/@bunny.net/edgescript-sdk@0.11"; |
| 24 | +import * as BunnySDK from "@bunny.net/edgescript-sdk"; |
| 25 | + |
| 26 | +function sleep(ms: number): Promise<void> { |
| 27 | + return new Promise((resolve) => setTimeout(resolve, ms)); |
| 28 | +} |
17 | 29 |
|
18 | 30 | console.log("Starting server..."); |
19 | | -BunnySDK.net.http.serve(async (req) => { |
| 31 | + |
| 32 | +BunnySDK.net.http.serve({ port: 8080, hostname: '127.0.0.1' }, async (req) => { |
20 | 33 | console.log(`[INFO]: ${req.method} - ${req.url}`); |
21 | | - return new Response("Hello bunny!"); |
| 34 | + await sleep(1000); // Simulate some processing delay |
| 35 | + return new Response("Hello, Bunny Edge!"); |
22 | 36 | }); |
23 | 37 | ``` |
| 38 | + |
| 39 | +This example sets up a local HTTP server using the Bunny Edge Scripting SDK. You can access the server at 127.0.0.1:8080 and observe the real-time request logs. This setup mimics the way Bunny's edge network handles requests, providing a consistent development experience. |
| 40 | + |
| 41 | +### Parameter Explanation |
| 42 | + |
| 43 | +- **`port`**: The port on which the server will listen for incoming HTTP requests. In this example, `8080` is specified, so you can access the server at [http://127.0.0.1:8080](http://127.0.0.1:8080). |
| 44 | + |
| 45 | +- **`hostname`**: The hostname or IP address for the server. Here, `'127.0.0.1'` restricts the server to listen only on the local machine (localhost). To make it accessible over the network, you could set it to `'0.0.0.0'`, allowing other devices to connect to the server. |
| 46 | + |
| 47 | +## 🚀 Deploying to Bunny Edge |
| 48 | +After local development and testing, deploying to Bunny Edge Scripting is straightforward. Simply push your code to your Bunny Edge Scripting project’s GitHub repository, and it will be automatically deployed across Bunny’s global CDN. |
| 49 | + |
| 50 | +Once deployed, Bunny’s serve function processes incoming requests through a connected Pull Zone, allowing your application to deliver data from the edge with maximum speed and minimal latency. |
| 51 | + |
| 52 | +## 🚨 Error Handling and Logging |
| 53 | +Bunny Edge Scripting includes built-in logging to support error tracking and observability. Use console.log, console.warn, and console.error statements within your code to monitor application flow, debug issues, and gather insights both locally and in deployment. |
0 commit comments