Skip to content

Update readme #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JonathanHemnes wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update readme #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ apone.register({
app.listen(3000)
```

# table of contents
- [api](#api)
- [routes](#routes)
- [schemas](#schemas)
- [validationResults](#validationresult)
- [extensions](#extensions)
- [route-behavior](#route-behavior)
- [contributing](#contributing)
- [faq](#faq)
# Table of Contents
- [API](#api)
- [Routes](#routes)
- [Rchemas](#schemas)
- [ValidationResult](#validationresult)
- [Extensions](#extensions)
- [Route Behavior](#route-behavior)
- [Contributing](#contributing)
- [FAQ](#faq)

# API

Expand Down Expand Up @@ -65,7 +65,7 @@ By defining the following properties, routes opt-into different behaviors. Each
- `prefix` - `string` path prefix which takes priority over Apone's [constructor option](#api) global prefix
- `metadata` - `object` - flexible bucket for anything else

### example:
### Example:

```js
let route = {
Expand Down Expand Up @@ -108,7 +108,7 @@ Schemas are used to validate user requests. [Joi](https://github.com/hapijs/joi)
## Properties
- `validate` - `function` which must return a [ValidationResult](#validationresult)

### example:
### Example:
```js
let schema = {
validate: (body) => {
Expand All @@ -129,7 +129,7 @@ Returned by [schema](#schemas) validation
- `error` - `Error` object
- `value` - `any` coerced and sanitized result

### example:
### Example:

```js
let validationResult = {
Expand All @@ -148,7 +148,7 @@ Extensions are custom [route properties](#routes). They must be defined in the A
- `type` - `string` defaults to `pre`, or optionally `post`.


### example:
### Example:
The following extension adds a traceId to each request prior to validation. First, Apone is instantiated with the `trace` extension. During registration, `trace(true)` is called and the return function is added to the stack. Extensions execute in order, by type.

```js
Expand Down