Merge pull request #90 from javierbrea/typescript-support

Typescript support

Author: javierbrea

CHANGELOG.md

@@ -11,6 +11,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Removed
 ### BREAKING CHANGES
 
+## [1.2.0] - 2020-05-31
+
+### Added
+- feat(TypeScript): Add TypeScript support
+
 ## [1.1.10] - 2020-05-16
 
 ### Added

README.md

@@ -150,6 +150,26 @@ describe("localStorage cookies-accepted item", () => {
 });
 ```
 
+## Usage with TypeScript
+
+For those writing [TypesScript tests in Cypress][cypress-typescript], this package includes TypeScript declarations.
+
+Add "cypress-localstorage-commands" to the `types` property of the `tsconfig.json` file:
+
+```json
+{
+  "compilerOptions": {
+    "types": ["cypress", "cypress-localstorage-commands"]
+  }
+}
+```
+
+Or reference the package in the files using it:
+
+```typescript
+/// <reference types="cypress-localstorage-commands" />
+```
+
 ## Contributing
 
 Contributors are welcome.
@@ -175,3 +195,5 @@ MIT, see [LICENSE](./LICENSE) for details.
 [quality-gate-url]: https://sonarcloud.io/dashboard?id=cypress-localstorage-commands
 [release-image]: https://img.shields.io/github/release-date/javierbrea/cypress-localstorage-commands.svg
 [release-url]: https://github.com/javierbrea/cypress-localstorage-commands/releases
+
+[cypress-typescript]: https://docs.cypress.io/guides/tooling/typescript-support.html

index.d.ts

@@ -0,0 +1,45 @@
+/// <reference types="cypress" />
+
+declare namespace Cypress {
+  interface Chainable {
+    /**
+     * Command to save current localStorage values into an internal "snapshot"
+     * @example cy.saveLocalStorage()
+    */
+    saveLocalStorage(): Chainable<Element>
+
+    /**
+     * Command to restore localStorage to previously "snapshot" saved values
+     * @example cy.restoreLocalStorage()
+    */
+    restoreLocalStorage(): Chainable<Element>
+
+    /**
+     * Command to clear localStorage "snapshot" values
+     * @example cy.clearLocalStorageSnapshot()
+    */
+    clearLocalStorageSnapshot(): Chainable<Element>
+
+    /**
+     * Command to get localStorage item value
+     * @param {string} itemKeyName - localStorage item to get
+     * @example cy.getLocalStorage("cookies-accepted")
+    */
+    getLocalStorage(itemKeyName: string): Chainable<Element>
+
+    /**
+     * Command to set localStorage item value
+     * @param {string} itemKeyName - localStorage item to set
+     * @param {string} value - value to be set
+     * @example cy.setLocalStorage("cookies-accepted", "true")
+    */
+    setLocalStorage(itemKeyName: string, value: string): Chainable<Element>
+
+    /**
+     * Command to remove localStorage item
+     * @param {string} itemKeyName - localStorage item to remove
+     * @example cy.removeLocalStorage("cookies-accepted")
+    */
+    removeLocalStorage(itemKeyName: string): Chainable<Element>
+  }
+}