unexpected/documentation/assertions/object/to-be-canonical.md

Extensible BDD assertion toolkit

Asserts that an object has its properties defined in sorted order at
all levels.

```javascript
expect({ a: 123, b: 456 }, 'to be canonical');
expect([456, { a: 123 }], 'to be canonical');
```

In case of a failing expectation you get the following output:

```javascript
expect([456, { b: 456, a: 123 }], 'to be canonical');
```

```output
expected [ 456, { b: 456, a: 123 } ] to be canonical
```