@routup/query

This is a plugin for reading and parsing the query string of the request url.

Table of Contents

• Installation
• Documentation
• Usage
• Helpers
  • setRequestQuery
  • useRequestQuery
• License

Installation

npm install @routup/query --save

Documentation

To read the docs, visit https://routup.net

Usage

It is important to invoke the request middleware, to parse the query-string of the request url.

import {
    Router,
    defineCoreHandler,
    serve,
} from 'routup';
import {
    query,
    useRequestQuery
} from '@routup/query';

const router = new Router();

router.use(query());

router.get('/', defineCoreHandler((event) => {
    const q = useRequestQuery(event);
    console.log(q);
    // { key: ..., ... }

    return q;
}));

serve(router, { port: 3000 });

Helpers

setRequestQuery

This function sets the parsed request query parameters for the current request.

declare function setRequestQuery(
    event: IRoutupEvent,
    key: string,
    value: unknown
) : void;

declare function setRequestQuery(
    event: IRoutupEvent, 
    record: Record<string, any>
) : void;

useRequestQuery

This function returns the query parameters of the request.

declare function useRequestQuery(
    event: IRoutupEvent
) : Record<string, any>;

declare function useRequestQuery(
    event: IRoutupEvent, 
    key: string
) : any;

License

Made with 💚

Published under MIT License.