Skip to content

Commit

Permalink
Adding note in docs about passing condition instance into condition i…
Browse files Browse the repository at this point in the history
…nitializer
  • Loading branch information
fishcharlie committed Apr 6, 2020
1 parent af846c4 commit e5c0b88
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/api/Condition.md
Expand Up @@ -9,6 +9,7 @@ This is the basic entry point to construct a conditional. The filter property is
```js
new dynamoose.Condition("breed").contains("Terrier") // will condition for where the key `breed` contains `Terrier`
new dynamoose.Condition({"breed": {"contains": "Terrier"}}) // will condition for where the key `breed` contains `Terrier`
new dynamoose.Condition(new dynamoose.Condition({"breed": {"contains": "Terrier"}})) // will condition for where the key `breed` contains `Terrier`
```

If you pass an object into `new dynamoose.Condition()` the object for each key should contain the comparison type. For example, in the last example above, `contains` was our comparison type. This comparison type must match one of the comparison type functions listed on this page.
Expand Down

0 comments on commit e5c0b88

Please sign in to comment.