refactor: rename utilities and deprecate old ones

README.md

@@ -25,18 +25,18 @@ pnpm install h3-typebox
 ```js
 import { createServer } from 'http'
 import { createApp } from 'h3'
-import { useValidatedBody, useValidatedQuery, Type } from 'h3-typebox'
+import { validateBody, validateQuery, Type } from 'h3-typebox'
 
 const app = createApp()
 app.use('/', async (req) => {
   // Validate body
-  const body = await useValidatedBody(req, Type.Object({
+  const body = await validateBody(req, Type.Object({
     optional: Type.Optional(Type.String()),
     required: Type.Boolean(),
   }))
 
   // Validate query
-  const query = useValidatedQuery(req, Type.Object({
+  const query = validateQuery(req, Type.Object({
     required: Type.String(),
   }))
 })

src/body.ts

@@ -2,7 +2,7 @@ import type { Static, TSchema } from '@sinclair/typebox'
 import { createError, useBody, CompatibilityEvent } from 'h3'
 import { useValidator } from './utils'
 
-export async function useValidatedBody<T extends TSchema> (event: CompatibilityEvent, schema: T) {
+export async function validateBody<T extends TSchema> (event: CompatibilityEvent, schema: T) {
   const body = await useBody(event)
   const validate = useValidator().compile(schema)
 
@@ -12,3 +12,7 @@ export async function useValidatedBody<T extends TSchema> (event: CompatibilityE
 
   return body as Static<T>
 }
+
+/** @deprecated Use `validateBody` */
+/* c8 ignore next */
+export const useValidatedBody = validateBody

src/query.ts

@@ -2,7 +2,7 @@ import type { Static, TSchema } from '@sinclair/typebox'
 import { createError, CompatibilityEvent, useQuery } from 'h3'
 import { useValidator } from './utils'
 
-export function useValidatedQuery<T extends TSchema> (event: CompatibilityEvent, schema: T) {
+export function validateQuery<T extends TSchema> (event: CompatibilityEvent, schema: T) {
   const query = useQuery(event)
   const validate = useValidator().compile(schema)
 
@@ -12,3 +12,7 @@ export function useValidatedQuery<T extends TSchema> (event: CompatibilityEvent,
 
   return query as Static<T>
 }
+
+/** @deprecated Use `validateQuery` */
+/* c8 ignore next */
+export const useValidatedQuery = validateQuery

test/body.test.ts

@@ -1,9 +1,9 @@
 import supertest, { SuperTest, Test } from 'supertest'
 import { describe, beforeEach, it, expect } from 'vitest'
 import { createApp, App } from 'h3'
-import { useValidatedBody, Type } from '../src'
+import { validateBody, Type } from '../src'
 
-describe('useValidatedBody', () => {
+describe('validateBody', () => {
   let app: App
   let request: SuperTest<Test>
 
@@ -18,15 +18,15 @@ describe('useValidatedBody', () => {
   })
 
   it('returns 200 OK if body matches validation schema', async () => {
-    app.use('/validate', async req => await useValidatedBody(req, bodySchema))
+    app.use('/validate', async req => await validateBody(req, bodySchema))
 
     const res = await request.post('/validate').send({ required: true })
 
     expect(res.status).toEqual(200)
   })
 
   it('throws 400 Bad Request if body does not match validation schema', async () => {
-    app.use('/validate', async req => await useValidatedBody(req, bodySchema))
+    app.use('/validate', async req => await validateBody(req, bodySchema))
 
     const res = await request.post('/validate').send({})
 

test/query.test.ts

@@ -1,9 +1,9 @@
 import supertest, { SuperTest, Test } from 'supertest'
 import { describe, beforeEach, it, expect } from 'vitest'
 import { createApp, App } from 'h3'
-import { useValidatedQuery, Type } from '../src'
+import { validateQuery, Type } from '../src'
 
-describe('useValidatedQuery', () => {
+describe('validateQuery', () => {
   let app: App
   let request: SuperTest<Test>
 
@@ -17,15 +17,15 @@ describe('useValidatedQuery', () => {
   })
 
   it('returns 200 OK if query matches validation schema', async () => {
-    app.use('/validate', req => useValidatedQuery(req, querySchema))
+    app.use('/validate', req => validateQuery(req, querySchema))
 
     const res = await request.get('/validate?required')
 
     expect(res.status).toEqual(200)
   })
 
   it('throws 400 Bad Request if query does not match validation schema', async () => {
-    app.use('/validate', req => useValidatedQuery(req, querySchema))
+    app.use('/validate', req => validateQuery(req, querySchema))
 
     const res = await request.get('/validate')