fix: add DefaultValue to addProperty method

cypress-io · Oct 3, 2018 · 8bff6cf · 8bff6cf
1 parent bc4ecd5
commit 8bff6cf
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/src/actions.ts b/src/actions.ts
@@ -1,5 +1,10 @@
-import { clone, equals, reject, mergeDeepRight } from 'ramda'
-import { JsonProperties, JsonPropertyTypes, ObjectSchema } from './objects'
+import { clone, equals, mergeDeepRight, reject } from 'ramda'
+import {
+  DefaultValue,
+  JsonProperties,
+  JsonPropertyTypes,
+  ObjectSchema,
+} from './objects'
 import { normalizeRequiredProperties } from './utils'
 
 //
@@ -19,6 +24,7 @@ type AddPropertyOptions = {
   exampleValue: any
   isRequired?: boolean
   propertyDescription?: string
+  defaultValue?: DefaultValue
   see?: string | ObjectSchema
 }
 

diff --git a/src/objects.ts b/src/objects.ts
@@ -36,6 +36,8 @@ export type JsonPropertyTypes =
   | string[]
   | number[]
 
+export type DefaultValue = null | boolean | number | string
+
 export type JsonProperty = {
   type: JsonPropertyTypes
   format?: string
@@ -61,9 +63,9 @@ export type JsonProperty = {
    * An explicit default value if we fill an object to match schema.
    * For now allows a limited set of primitive types
    *
-   * @type {(null | boolean | number | string)}
+   * @type {DefaultValue}
    */
-  defaultValue?: null | boolean | number | string
+  defaultValue?: DefaultValue
 }
 
 export type JsonProperties = {