diff --git a/README.md b/README.md index 0cb2190..97c9042 100644 --- a/README.md +++ b/README.md @@ -140,13 +140,13 @@ spaceSlug([ | Function | Type | | ---------- | ---------- | -| `word` | `(type: string) => (count?: number, _words?: string[]) => (options: SpaceSlugOptions) => Set` | +| `word` | `(type: string) => (count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set` | ### :gear: digits | Function | Type | | ---------- | ---------- | -| `digits` | `(count?: number, noConsecutive?: boolean) => (options: SpaceSlugOptions) => string` | +| `digits` | `(count?: number or undefined, noConsecutive?: boolean or undefined) => (options: SpaceSlugOptions) => string` | ### :gear: cleanString @@ -164,7 +164,7 @@ spaceSlug([ | Function | Type | | ---------- | ---------- | -| `spaceSlug` | `(spaceSlugInputs?: SpaceSlugInput[], options?: SpaceSlugOptions) => string` | +| `spaceSlug` | `(spaceSlugInputs?: SpaceSlugInput[] or undefined, options?: SpaceSlugOptions) => string` | ## :wrench: Constants @@ -196,49 +196,49 @@ spaceSlug([ | Constant | Type | | ---------- | ---------- | -| `noun` | `(count?: number, _words?: string[]) => (options: SpaceSlugOptions) => Set` | +| `noun` | `(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set` | ### :gear: adjective | Constant | Type | | ---------- | ---------- | -| `adjective` | `(count?: number, _words?: string[]) => (options: SpaceSlugOptions) => Set` | +| `adjective` | `(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set` | ### :gear: color | Constant | Type | | ---------- | ---------- | -| `color` | `(count?: number, _words?: string[]) => (options: SpaceSlugOptions) => Set` | +| `color` | `(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set` | ### :gear: season | Constant | Type | | ---------- | ---------- | -| `season` | `(count?: number, _words?: string[]) => (options: SpaceSlugOptions) => Set` | +| `season` | `(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set` | ### :gear: emoji | Constant | Type | | ---------- | ---------- | -| `emoji` | `(count?: number, _words?: string[]) => (options: SpaceSlugOptions) => Set` | +| `emoji` | `(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set` | ### :gear: verb | Constant | Type | | ---------- | ---------- | -| `verb` | `(count?: number, _words?: string[]) => (options: SpaceSlugOptions) => Set` | +| `verb` | `(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set` | ### :gear: animal | Constant | Type | | ---------- | ---------- | -| `animal` | `(count?: number, _words?: string[]) => (options: SpaceSlugOptions) => Set` | +| `animal` | `(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set` | ### :gear: cosmos | Constant | Type | | ---------- | ---------- | -| `cosmos` | `(count?: number, _words?: string[]) => (options: SpaceSlugOptions) => Set` | +| `cosmos` | `(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set` |