Skip to content

Commit

Permalink
Finish Queues docs
Browse files Browse the repository at this point in the history
  • Loading branch information
campb303 committed Apr 3, 2021
1 parent a6740a4 commit 468b23a
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/api/Queues.md
Original file line number Diff line number Diff line change
@@ -1 +1,33 @@
# Queues

A collection of [Items](/api/Items/).

## Properties

### `Queue.name`
Type | Description
- | -
`String` | The name of the queue.

!!! example
```js
console.log(Queue.name)
// Expected Output
"ce"
```

### `Queue.items`
Type | Description
- | -
`Array<Object>` | The [Items](/api/Items/) in the queue.

!!! example
```js
console.log(Queue.items)
// Expected Output
[
{ queue: "ce", number: 01, lastUpdated: "2021-03-26T17:12:00-0400" ... }
{ queue: "ce", number: 02, lastUpdated: "2021-05-29T17:12:00-0400" ... }
{ queue: "ce", number: 03, lastUpdated: "2020-12-29T17:12:00-0400" ... }
]
```

0 comments on commit 468b23a

Please sign in to comment.