uwebsockets utilities
yarn add uwu@joshxyzhimself/uwu#v0.1.2
const uwu = require('uwu');
const uws = uwu.uws;- Notes
handlerfunction hasresponseandrequestparameters
- Parameters
handler-Function, async function for handling request
responsepropertiesresponse.status- Number, for HTTP statusresponse.headers- Object, for HTTP headersresponse.text- String, override if sendingtext/plainresponse.html- String, override if sendingtext/htmlresponse.json- Object, override if sendingapplication/jsonresponse.buffer- Buffer, override if sendingapplication/octet-streamresponse.file_name- String, file name forcontent-dispositionresponse.file_dispose- Boolean, usescontent-dispositionresponse.file_cache- Boolean, cache static files in memory, defaults tofalseresponse.file_cache_max_age_ms- Number, cached static files max age in ms, defaults toInfinityresponse.compress- Boolean, compresses response, defaults tofalse
requestpropertiesrequest.url- Stringrequest.query- Stringrequest.method- Stringrequest.headers- Object, HTTP headersrequest.headers.host- Stringrequest.headers.accept- Stringrequest.headers.accept_encoding- Stringrequest.headers.content_type- Stringrequest.headers.if_none_match- Stringrequest.headers.user_agent- Stringrequest.json- Object, receivedapplication/json
// Logging request; serving HTML
app.get('/*', uwu.serve_handler(async (response, request) => {
console.log({ request });
response.html = `
<html>
<body>
<h4>Hello world!</h4>
</body>
</html>
`;
}));
// Setting headers; serving JSON
app.get('/test-json', uwu.serve_handler(async (response, request) => {
response.headers['Cache-Control'] = uwu.cache_control_types.no_store;
response.json = { foo: 'bar', random: Math.random() };
}));
// Serving file
app.get('/test3', uwu.serve_handler(async (response, request) => {
console.log({ request });
response.headers['Cache-Control'] = uwu.cache_control_types.no_cache;
response.file_path = __filename;
response.file_cache = true;
response.compress = true;
response.file_dispose = false;
}));- Notes
- For serving static files
- Used before using
uwu.serve_handler.
- Parameters
app-Object, uWebSockets app instanceroute_path-String, web route pathlocal_path-String, local file folder path (relative to process.cwd())response_override?-Object, overrides the response object, e.g. overriding cache-control headers
uwu.serve_static(app, '/scripts/', '/scripts/');- Notes
- Exposed built-in values for
cache-controlheader
- Exposed built-in values for
const cache_control_types = {
// For sensitive data
no_store: 'no-store, max-age=0',
// For dynamic data
no_cache: 'no-cache',
// For private static data (1 hour)
private_cached: 'private, max-age=3600, s-maxage=3600',
// For public static data (1 day)
public_cached: 'public, max-age=86400, s-maxage=86400',
};