Skip to content

Commit 387f2da

Browse files
committed
rename to uttp
1 parent ce174c3 commit 387f2da

File tree

15 files changed

+47
-47
lines changed

15 files changed

+47
-47
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# unhttp
1+
# uttp
22

33
write your request handlers once, run anywhere
44

@@ -15,7 +15,7 @@ currently supports:
1515
## Install
1616

1717
```sh
18-
npm install unhttp
18+
npm install uttp
1919
```
2020

2121
## Usage
@@ -24,7 +24,7 @@ First, define your universal request handler:
2424

2525
```ts
2626
// handler.ts
27-
import { defineHandler } from 'unhttp'
27+
import { defineHandler } from 'uttp'
2828

2929
export const handler = defineHandler(() => {
3030
// return an object that will be used by each adapter
@@ -44,15 +44,15 @@ export const handler = defineHandler(() => {
4444
})
4545
```
4646

47-
For all server frameworks unhttp supports this will show `Hello world!` as HTML.
47+
For all server frameworks uttp supports this will show `Hello world!` as HTML.
4848

4949
Then you can use adapters to get middleware/plugins/handlers for the server frameworks.
5050

5151
For Node:
5252

5353
```ts
5454
// adapters/node.ts
55-
import { getNodeAdapter } from 'unhttp/adapters/node'
55+
import { getNodeAdapter } from 'uttp/adapters/node'
5656
import { handler } from '../handler'
5757

5858
export const nodeHandler = getNodeAdapter(handler)
@@ -74,7 +74,7 @@ For Fastify:
7474

7575
```ts
7676
// adapters/fastify.ts
77-
import { getFastifyAdapter } from 'unhttp/adapters/fastify'
77+
import { getFastifyAdapter } from 'uttp/adapters/fastify'
7878
import { handler } from '../handler'
7979

8080
export const getFastifyPlugin = getFastifyAdapter(handler)
@@ -92,14 +92,14 @@ server.register(await getFastifyPlugin())
9292
server.listen(3000)
9393
```
9494

95-
Note these placed in a different entry point / file because `unhttp/adapters/*` imports directly from the server frameworks. You cannot export multiple handlers from the same entry point because users would be forced to install server frameworks that they are not using.
95+
Note these placed in a different entry point / file because `uttp/adapters/*` imports directly from the server frameworks. You cannot export multiple handlers from the same entry point because users would be forced to install server frameworks that they are not using.
9696

9797
### Request
9898

9999
A universal request object is passed to `handleRequest` containing some common properties coerced from the individual frameworks:
100100

101101
```ts
102-
import { defineHandler } from 'unhttp'
102+
import { defineHandler } from 'uttp'
103103

104104
export const handler = defineHandler(() => {
105105
return {
@@ -124,7 +124,7 @@ export const handler = defineHandler(() => {
124124
Request handlers are passed a set of universal functions that vary in implementation across frameworks but retain the same signature:
125125

126126
```ts
127-
import { defineHandler } from 'unhttp'
127+
import { defineHandler } from 'uttp'
128128

129129
export const handler = defineHandler((helpers) => {
130130
return {
@@ -159,7 +159,7 @@ If you need a helper that is not currently available, please create an issue.
159159
Your request handler can take in options from users of your handler:
160160

161161
```ts
162-
import { defineHandler } from 'unhttp'
162+
import { defineHandler } from 'uttp'
163163

164164
interface HandlerOptions {
165165
parse(text: string): any | Promise<any>
@@ -205,7 +205,7 @@ server.listen(3000)
205205
You must return an `adapterOptions` object. These options may be derived from user options. Here is an example with a description of what each option does:
206206

207207
```ts
208-
import { defineHandler } from 'unhttp'
208+
import { defineHandler } from 'uttp'
209209

210210
export const handler = defineHandler(() => {
211211
return {
@@ -222,6 +222,6 @@ export const handler = defineHandler(() => {
222222

223223
## Starter Templates
224224

225-
See starter templates for how to setup a package that uses `unhttp`.
225+
See starter templates for how to setup a package that uses uttp.
226226

227-
- [unhttp-starter](examples/starter)
227+
- [uttp-starter](examples/starter)

examples/starter/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
1-
# unhttp-starter
1+
# uttp-starter
22

3-
Starter template for unhttp.
3+
Starter template for uttp.
44

55
## Usage
66

77
1. Clone the template:
88

99
```
10-
npx degit sachinraja/unhttp/examples/starter
10+
npx degit sachinraja/uttp/examples/starter
1111
```
1212

13-
2. Replace all instances of `unhttp-starter` with your package name.
13+
2. Replace all instances of `uttp-starter` with your package name.
1414

1515
3. Start developing! Most of the work should be done in [`src/handler.ts`](src/handler.ts).
1616

1717
## Install
1818

1919
```sh
20-
npm install unhttp-starter
20+
npm install uttp-starter
2121
```
2222

2323
<details>
2424
<summary>Node</summary><br>
2525

2626
```ts
2727
import { createServer } from 'http'
28-
import { nodeHandler } from 'unhttp-starter/adapters/node'
28+
import { nodeHandler } from 'uttp-starter/adapters/node'
2929

3030
const server = createServer(await nodeHandler(/* options */))
3131
```
@@ -38,7 +38,7 @@ Example: [`scripts/node-server.ts`](scripts/node-server.ts)
3838
<summary>Express</summary><br>
3939

4040
```ts
41-
import { expressHandler } from 'unhttp-starter/adapters/express'
41+
import { expressHandler } from 'uttp-starter/adapters/express'
4242

4343
app.use(await expressHandler(/* options */))
4444
```
@@ -49,7 +49,7 @@ app.use(await expressHandler(/* options */))
4949
<summary>Fastify</summary><br>
5050

5151
```ts
52-
import { getFastifyPlugin } from 'unhttp-starter/adapters/fastify'
52+
import { getFastifyPlugin } from 'uttp-starter/adapters/fastify'
5353

5454
server.register(await getFastifyPlugin(/* options */))
5555
```
@@ -61,7 +61,7 @@ server.register(await getFastifyPlugin(/* options */))
6161

6262
```ts
6363
// Cloudflare Workers example
64-
import { fetchHandler } from 'unhttp-starter/adapters/fetch'
64+
import { fetchHandler } from 'uttp-starter/adapters/fetch'
6565

6666
export default {
6767
fetch: await fetchHandler(/* options */),
@@ -74,7 +74,7 @@ export default {
7474
<summary>h3</summary><br>
7575

7676
```ts
77-
import { h3Handler } from 'unhttp-starter/adapters/h3'
77+
import { h3Handler } from 'uttp-starter/adapters/h3'
7878

7979
app.use(await h3Handler(/* options */))
8080
```
@@ -88,7 +88,7 @@ app.use(await h3Handler(/* options */))
8888

8989
<!-- dprint-ignore -->
9090
```ts
91-
import { h3Handler } from 'unhttp-starter/adapters/h3'
91+
import { h3Handler } from 'uttp-starter/adapters/h3'
9292

9393
const eventHandler = await h3Handler(/* options */)
9494

@@ -101,7 +101,7 @@ export default eventHandler
101101
<summary>Koa</summary><br>
102102

103103
```ts
104-
import { koaHandler } from 'unhttp-starter/adapters/koa'
104+
import { koaHandler } from 'uttp-starter/adapters/koa'
105105

106106
app.use(await koaHandler(/* options */))
107107
```
@@ -113,7 +113,7 @@ app.use(await koaHandler(/* options */))
113113

114114
<!-- dprint-ignore -->
115115
```ts
116-
import { awsLambdaHandler } from 'unhttp-starter/adapters/aws-lambda'
116+
import { awsLambdaHandler } from 'uttp-starter/adapters/aws-lambda'
117117

118118
// requires es modules/top-level await/Node.js 14 runtime
119119
export const handler = await awsLambdaHandler(/* options */)

examples/starter/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "unhttp-starter",
2+
"name": "uttp-starter",
33
"version": "0.0.0",
44
"private": true,
55
"type": "module",
@@ -26,7 +26,7 @@
2626
"test:node": "node --loader esbuild-node-loader scripts/node-client.ts"
2727
},
2828
"keywords": [
29-
"unhttp"
29+
"uttp"
3030
],
3131
"peerDependencies": {
3232
"express": "^4",
@@ -35,7 +35,7 @@
3535
"koa": "^2"
3636
},
3737
"dependencies": {
38-
"unhttp": "^0.0.0",
38+
"uttp": "^0.0.0",
3939
"zod": "^3.17.3"
4040
},
4141
"devDependencies": {
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { getAwsLambdaAdapter } from 'unhttp/adapters/aws-lambda'
1+
import { getAwsLambdaAdapter } from 'uttp/adapters/aws-lambda'
22
import { handler } from '../handler.js'
33

44
export const awsLambdaHandler = getAwsLambdaAdapter(handler)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { getExpressAdapter } from 'unhttp/adapters/express'
1+
import { getExpressAdapter } from 'uttp/adapters/express'
22
import { handler } from '../handler.js'
33

44
export const expressHandler = getExpressAdapter(handler)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { getFastifyAdapter } from 'unhttp/adapters/fastify'
1+
import { getFastifyAdapter } from 'uttp/adapters/fastify'
22
import { handler } from '../handler.js'
33

44
export const getFastifyPlugin = getFastifyAdapter(handler)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { getFetchAdapter } from 'unhttp/adapters/fetch'
1+
import { getFetchAdapter } from 'uttp/adapters/fetch'
22
import { handler } from '../handler.js'
33

44
export const fetchHandler = getFetchAdapter(handler)

examples/starter/src/adapters/h3.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { getH3Adapter } from 'unhttp/adapters/h3'
1+
import { getH3Adapter } from 'uttp/adapters/h3'
22
import { handler } from '../handler.js'
33

44
export const h3Handler = getH3Adapter(handler)

examples/starter/src/adapters/koa.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { getKoaAdapter } from 'unhttp/adapters/koa'
1+
import { getKoaAdapter } from 'uttp/adapters/koa'
22
import { handler } from '../handler.js'
33

44
export const koaHandler = getKoaAdapter(handler)

examples/starter/src/adapters/node.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { getNodeAdapter } from 'unhttp/adapters/node'
1+
import { getNodeAdapter } from 'uttp/adapters/node'
22
import { handler } from '../handler'
33

44
export const nodeHandler = getNodeAdapter(handler)

0 commit comments

Comments
 (0)