A collection of helpful functions for building Netlify Functions
MIT License
A collection of helpful functions for building Netlify Functions
[!IMPORTANT] This package relies on
FormData
andFile
support, which was added in Node 20 and will be available on Netlify and AWS Lambda sometime after it reaches LTS on or about 2023-10-24. In Node 18,FormData
is supported, but uploads will beBlob
s instead ofFile
s.
NetlifyRequest
class extending Request
HandlerEvent
eventsearchParams
property (URLSearchParams
)cookies
property as a Map
from the Cookie
headercreateHandler
function
NetlifyRequest
object and must return a Response
import { createHandler } from '@shgysk8zer0/netlify-func-utils`;
import { BAD_REQUEST, NOT_AUTHORIZED } from '@shgysk8zer0/http/status';
import { HttpError } from '@shgysk8zer0/http/error';
export const handler = createHandler({
get: async req => {
if (req.searchParams.has('id')) {
return Response.json(await getItem(req.searchParams.get('id)));
}
},
post: async req = {
if (! req.cookies.has('token')) {
throw new HTTPError('You must be signed-in.', { status: NOT_AUTHORIZED });
} else {
const data = await req.formData(); // `FormData`, including `File` objects
if (! data.has('required-field')) {
throw new HTTPError('Missing requied field.', { status: BAD_REQUEST });
} else {
// Maybe save something to a DB.
return Response.json({ created: item.id });
}
}
},
delete: async req => {
//
},
}, {
cors: true,
headers: new Headers({ 'X-UID': crypto.randomUUID() }),
allowHeaders: ['X-Foo', 'X-UID'],
}