Skip to content

Commit

Permalink
Adds preference model documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
coconutcraig committed Jan 14, 2019
1 parent 3006df1 commit 07f16da
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,34 @@ class Locations {
}
```

### Preferences

##### Methods

- `between(start: string, end: string)`

Set the attributes to determine the start and end time of the wait list request preference.

- `next()`

Set an attribute to say that the preference is for the next available opening.

- `on(day: number)`

Set the attribute to determine the preferred day of the wait list request preference and that it should only be for the certain supplied days.

##### Example

```javascript
import { Preference } from 'coconut-open-api-js';

class Preferences {
static create({ day, start, end }) {
return (new Preference).between(start, end).on(day);
}
}
```

### Questions

##### Methods
Expand Down

0 comments on commit 07f16da

Please sign in to comment.