Merge pull request #85 from argos-ci/fix-cypress-typescript

fix(cypress): fix typescript
argos-ci · Nov 17, 2023 · 102bb11 · 102bb11
2 parents 1959c3d + 0a6f598
commit 102bb11
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/packages/cypress/docs/index.mdx b/packages/cypress/docs/index.mdx
@@ -57,6 +57,20 @@ Look at Argos doc to know [how to configure your CI](https://argos-ci.com/docs/u
 
 As Cypress store the screenshots into the "cypress/screenshots" folder by default, have to specify it when you use Argos CLI command: `npx @argos-ci/cli upload cypress/screenshots`.
 
+## TypeScript support
+
+Typings should be added as follows in `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "types": ["cypress", "@argos-ci/cypress"]
+  }
+}
+```
+
+You can find [library definition here](https://github.com/argos-ci/argos-javascript/blob/main/packages/cypress/src/support.ts).
+
 ## API Overview
 
 ### cy.argosScreenshot([name][, options])

diff --git a/packages/cypress/package.json b/packages/cypress/package.json
@@ -31,6 +31,7 @@
     },
     "./package.json": "./package.json"
   },
+  "types": "./dist/support.d.ts",
   "engines": {
     "node": ">=16.0.0"
   },