Request API

[dhershman1]

This is subject to change as the planning continues and grows

Related Issues

• Routing API #2 Routing API
• Response API #3 Response API

Description

The Request API would work a lot like Response does in the sense, it's job is to handle the request object and provide easy ways to work with the data.

It will be contained within the request module and usable like so:

const { parse } = require('octoris/request')

Now also like response parse won't be it's only function it's just the only one in planning atm. Each function will be granted it's own issue.

Usage

The below example is simply giving the status code to the function and then the data, as mentioned above this may or may not be a thing.

const { parse } = require('octoris/request')
const { send } = require('octoris/response')

const postHandler = ctx => {
  const data = parse(ctx.data)

  if (!data) {
    return send(500, 'No Data Provided')
  }

  return send(200, 'Data Saved!')
}

[dhershman1]

Closing this for now, as a request API in itself may not be needed. Will re open once we can confirm what this should be doing.