README
cy-spok
Playing with spok inside Cypress test
CI | status |
---|---|
lint | |
badges | |
cy-spok | |
cy-spok-example | |
Learn
- Watch Introduction To cy-spok Plugin For Writing Powerful Assertions For Objects
- Read Asserting Network Calls from Cypress Tests
Install
$ npm i -D cy-spok
Use
See spok docs
// in your Cypress spec file
import spok from 'cy-spok'
const object = {
one: 1,
two: 2,
three: 3,
four: 4,
helloWorld: 'hello world',
anyNum: 999,
anotherNum: 888,
anArray: [1, 2],
anotherArray: [1, 2, 3],
anObject: {},
}
// using Spok
// https://github.com/thlorenz/spok#readme
cy.wrap(object, { timeout: 2000 }).should(
spok({
$topic: 'spok-example', // optional
one: spok.ge(1),
two: 2,
three: spok.range(2, 6),
four: spok.lt(5),
helloWorld: spok.startsWith('hello'),
anyNum: spok.type('number'),
anotherNum: spok.number,
anArray: spok.array,
anObject: spok.ne(undefined),
}),
)
See cypress/integration/spec.js here and in the cy-spok-example repo.
vs deep.equal
Spok prints a lot more information when using it compared to deep.equal
. Note that Spok is a subset, not strict value equality.
Small print
Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2021
License: MIT - do anything with the code, but don't blame me if it does not work.
Support: if you find any problems with this module, email / tweet / open issue on Github
MIT License
Copyright (c) 2021 Gleb Bahmutov <gleb.bahmutov@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.