Skip to content

Commit

Permalink
chore(example): Add Bun.sh example
Browse files Browse the repository at this point in the history
  • Loading branch information
blaine-arcjet committed May 15, 2024
1 parent a931576 commit 96cb69f
Show file tree
Hide file tree
Showing 8 changed files with 280 additions and 0 deletions.
1 change: 1 addition & 0 deletions examples/bun-rl/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ARCJET_KEY=
175 changes: 175 additions & 0 deletions examples/bun-rl/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore

# Logs

logs
_.log
npm-debug.log_
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Caches

.cache

# Diagnostic reports (https://nodejs.org/api/report.html)

report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json

# Runtime data

pids
_.pid
_.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover

lib-cov

# Coverage directory used by tools like istanbul

coverage
*.lcov

# nyc test coverage

.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)

.grunt

# Bower dependency directory (https://bower.io/)

bower_components

# node-waf configuration

.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)

build/Release

# Dependency directories

node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)

web_modules/

# TypeScript cache

*.tsbuildinfo

# Optional npm cache directory

.npm

# Optional eslint cache

.eslintcache

# Optional stylelint cache

.stylelintcache

# Microbundle cache

.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history

.node_repl_history

# Output of 'npm pack'

*.tgz

# Yarn Integrity file

.yarn-integrity

# dotenv environment variable files

.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)

.parcel-cache

# Next.js build output

.next
out

# Nuxt.js build / generate output

.nuxt
dist

# Gatsby files

# Comment in the public line in if your project uses Gatsby and not Next.js

# https://nextjs.org/blog/next-9-1#public-directory-support

# public

# vuepress build output

.vuepress/dist

# vuepress v2.x temp and cache directory

.temp

# Docusaurus cache and generated files

.docusaurus

# Serverless directories

.serverless/

# FuseBox cache

.fusebox/

# DynamoDB Local files

.dynamodb/

# TernJS port file

.tern-port

# Stores VSCode versions used for testing VSCode extensions

.vscode-test

# yarn v2

.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

# IntelliJ based IDEs
.idea

# Finder (MacOS) folder config
.DS_Store
15 changes: 15 additions & 0 deletions examples/bun-rl/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# bun-rl

To install dependencies:

```bash
bun install
```

To run:

```bash
bun run index.ts
```

This project was created using `bun init` in bun v1.1.8. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
Binary file added examples/bun-rl/bun.lockb
Binary file not shown.
1 change: 1 addition & 0 deletions examples/bun-rl/bunfig.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
telemetry = false
43 changes: 43 additions & 0 deletions examples/bun-rl/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import arcjet, { fixedWindow, shield } from "@arcjet/bun"

const aj = arcjet({
key: process.env.ARCJET_KEY!,
rules: [
shield({ mode: "LIVE" }),
fixedWindow({
mode: "LIVE",
max: 1,
window: "1m",
}),
],
});

// Exporting a server
export default {
port: 8080,
fetch: aj.wrap(async (req) => {
const decision = await aj.protect(req);

if (decision.isDenied()) {
return new Response("Blocked", { status: 403 });
}

return new Response("Hello world");
}),
};

// Or using the `Bun.serve()` API
// const server = Bun.serve({
// port: 8080,
// fetch: aj.wrap(async (req) => {
// const decision = await aj.protect(req);

// if (decision.isDenied()) {
// return new Response("Blocked", { status: 403 });
// }

// return new Response("Hello world");
// }),
// });

// console.log(`Listening on ${server.url}`);
18 changes: 18 additions & 0 deletions examples/bun-rl/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"name": "bun-rl",
"module": "index.ts",
"type": "module",
"workspaces": [
"../../*"
],
"dependencies": {
"@arcjet/bun": "workspace:*",
"@connectrpc/connect-node": "^1.4.0"
},
"devDependencies": {
"@types/bun": "latest"
},
"peerDependencies": {
"typescript": "^5.0.0"
}
}
27 changes: 27 additions & 0 deletions examples/bun-rl/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"compilerOptions": {
// Enable latest features
"lib": ["ESNext", "DOM"],
"target": "ESNext",
"module": "ESNext",
"moduleDetection": "force",
"jsx": "react-jsx",
"allowJs": true,

// Bundler mode
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"verbatimModuleSyntax": true,
"noEmit": true,

// Best practices
"strict": true,
"skipLibCheck": true,
"noFallthroughCasesInSwitch": true,

// Some stricter flags (disabled by default)
"noUnusedLocals": false,
"noUnusedParameters": false,
"noPropertyAccessFromIndexSignature": false
}
}

0 comments on commit 96cb69f

Please sign in to comment.