-
Notifications
You must be signed in to change notification settings - Fork 37
/
model.d.ts
2662 lines (2367 loc) · 83.6 KB
/
model.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import {
Association,
BelongsTo,
BelongsToMany,
BelongsToManyOptions,
BelongsToOptions,
HasMany,
HasManyOptions,
HasOne,
HasOneOptions,
} from './associations/index'
import { DataType } from './data-types'
import { AbstractDeferrable } from './deferrable'
import { ModelManager } from './model-manager'
import { Promise } from './promise'
import { QueryOptions } from './query-interface'
import { SyncOptions } from './sequelize'
import { Sequelize } from './sequelize'
import { Transaction } from './transaction'
import { Col, Fn, Literal, Where } from './utils'
export interface Logging {
/**
* A function that gets executed while running the query to log the sql.
*/
logging?: boolean | Function
}
export interface Transactionable {
/**
* Transaction to run query under
*/
transaction?: Transaction
}
export interface SearchPathable {
/**
* An optional parameter to specify the schema search_path (Postgres only)
*/
searchPath?: string
}
export interface Filterable {
/**
* Attribute has to be matched for rows to be selected for the given action.
*/
where?: WhereOptions
}
export interface Projectable {
/**
* A list of the attributes that you want to select. To rename an attribute, you can pass an array, with
* two elements - the first is the name of the attribute in the DB (or some kind of expression such as
* `Sequelize.literal`, `Sequelize.fn` and so on), and the second is the name you want the attribute to
* have in the returned instance
*/
attributes?: FindAttributeOptions
}
export interface Paranoid {
/**
* If true, only non-deleted records will be returned. If false, both deleted and non-deleted records will
* be returned. Only applies if `options.paranoid` is true for the model.
*/
paranoid?: boolean
}
export type GroupOption = string | Fn | Col | (string | Fn | Col)[]
/**
* Options to pass to Model on drop
*/
export interface DropOptions extends Logging {
/**
* Also drop all objects depending on this table, such as views. Only works in postgres
*/
cascade?: boolean
}
/**
* Schema Options provided for applying a schema to a model
*/
export interface SchemaOptions extends Logging {
/**
* The character(s) that separates the schema name from the table name
*/
schemaDelimeter?: string
}
/**
* Scope Options for Model.scope
*/
export interface ScopeOptions {
/**
* The scope(s) to apply. Scopes can either be passed as consecutive arguments, or as an array of arguments.
* To apply simple scopes and scope functions with no arguments, pass them as strings. For scope function,
* pass an object, with a `method` property. The value can either be a string, if the method does not take
* any arguments, or an array, where the first element is the name of the method, and consecutive elements
* are arguments to that method. Pass null to remove all scopes, including the default.
*/
method: string | any[]
}
/**
* The type accepted by every `where` option
*/
export type WhereOptions = WhereAttributeHash | AndOperator | OrOperator | Where
/**
* Example: `$any: [2,3]` becomes `ANY ARRAY[2, 3]::INTEGER`
*
* _PG only_
*/
export interface AnyOperator {
$any: (string | number)[]
}
/** Undocumented? */
export interface AllOperator {
$all: (string | number)[]
}
/**
* Operators that can be used in WhereOptions
*
* See http://docs.sequelizejs.com/en/v3/docs/querying/#operators
*/
export interface WhereOperators {
/**
* Example: `$any: [2,3]` becomes `ANY ARRAY[2, 3]::INTEGER`
*
* _PG only_
*/
$any?: (string | number)[]
/** Example: `$gte: 6,` becomes `>= 6` */
$gte?: number | string | Date
/** Example: `$lt: 10,` becomes `< 10` */
$lt?: number | string | Date
/** Example: `$lte: 10,` becomes `<= 10` */
$lte?: number | string | Date
/** Example: `$ne: 20,` becomes `!= 20` */
$ne?: string | number | WhereOperators
/** Example: `$not: true,` becomes `IS NOT TRUE` */
$not?: boolean | string | number | WhereOperators
/** Example: `$between: [6, 10],` becomes `BETWEEN 6 AND 10` */
$between?: [number, number]
/** Example: `$in: [1, 2],` becomes `IN [1, 2]` */
$in?: (string | number)[] | Literal
/** Example: `$notIn: [1, 2],` becomes `NOT IN [1, 2]` */
$notIn?: (string | number)[] | Literal
/**
* Examples:
* - `$like: '%hat',` becomes `LIKE '%hat'`
* - `$like: { $any: ['cat', 'hat']}` becomes `LIKE ANY ARRAY['cat', 'hat']`
*/
$like?: string | AnyOperator | AllOperator
/**
* Examples:
* - `$notLike: '%hat'` becomes `NOT LIKE '%hat'`
* - `$notLike: { $any: ['cat', 'hat']}` becomes `NOT LIKE ANY ARRAY['cat', 'hat']`
*/
$notLike?: string | AnyOperator | AllOperator
/**
* case insensitive PG only
*
* Examples:
* - `$iLike: '%hat'` becomes `ILIKE '%hat'`
* - `$iLike: { $any: ['cat', 'hat']}` becomes `ILIKE ANY ARRAY['cat', 'hat']`
*/
$ilike?: string | AnyOperator | AllOperator
/**
* case insensitive PG only
*
* Examples:
* - `$iLike: '%hat'` becomes `ILIKE '%hat'`
* - `$iLike: { $any: ['cat', 'hat']}` becomes `ILIKE ANY ARRAY['cat', 'hat']`
*/
$iLike?: string | AnyOperator | AllOperator
/**
* PG array overlap operator
*
* Example: `$overlap: [1, 2]` becomes `&& [1, 2]`
*/
$overlap?: [number, number]
/**
* PG array contains operator
*
* Example: `$contains: [1, 2]` becomes `@> [1, 2]`
*/
$contains?: any[]
/**
* PG array contained by operator
*
* Example: `$contained: [1, 2]` becomes `<@ [1, 2]`
*/
$contained?: any[]
/** Example: `$gt: 6,` becomes `> 6` */
$gt?: number | string | Date
/**
* PG only
*
* Examples:
* - `$notILike: '%hat'` becomes `NOT ILIKE '%hat'`
* - `$notLike: ['cat', 'hat']` becomes `LIKE ANY ARRAY['cat', 'hat']`
*/
$notILike?: string | AnyOperator | AllOperator
/** Example: `$notBetween: [11, 15],` becomes `NOT BETWEEN 11 AND 15` */
$notBetween?: [number, number]
}
/** Example: `$or: [{a: 5}, {a: 6}]` becomes `(a = 5 OR a = 6)` */
export interface OrOperator {
$or: WhereOptions | WhereOptions[] | WhereValue | WhereValue[]
}
/** Example: `$and: {a: 5}` becomes `AND (a = 5)` */
export interface AndOperator {
$and: WhereOptions | WhereOptions[] | WhereValue | WhereValue[]
}
/**
* Where Geometry Options
*/
export interface WhereGeometryOptions {
type: string
coordinates: (number[] | number)[]
}
/**
* Used for the right hand side of WhereAttributeHash.
* WhereAttributeHash is in there for JSON columns.
*/
export type WhereValue =
| string // literal value
| number // literal value
| boolean // literal value
| null
| WhereOperators
| WhereAttributeHash // for JSON columns
| Col // reference another column
| Fn
| OrOperator
| AndOperator
| WhereGeometryOptions
| (string | number | WhereAttributeHash)[] // implicit $or
/**
* A hash of attributes to describe your search.
*/
export interface WhereAttributeHash {
/**
* Possible key values:
* - A simple attribute name
* - A nested key for JSON columns
*
* {
* "meta.audio.length": {
* $gt: 20
* }
* }
*/
[field: string]: WhereValue | WhereOptions
}
/**
* Through options for Include Options
*/
export interface IncludeThroughOptions extends Filterable, Projectable {}
/**
* Options for eager-loading associated models, also allowing for all associations to be loaded at once
*/
export type Includeable = typeof Model | Association | IncludeOptions | { all: true }
/**
* Complex include options
*/
export interface IncludeOptions extends Filterable, Projectable {
/**
* The model you want to eagerly load
*/
model?: typeof Model
/**
* The alias of the relation, in case the model you want to eagerly load is aliassed. For `hasOne` /
* `belongsTo`, this should be the singular name, and for `hasMany`, it should be the plural
*/
as?: string
/**
* The association you want to eagerly load. (This can be used instead of providing a model/as pair)
*/
association?: Association
/**
* Note that this converts the eager load to an inner join,
* unless you explicitly set `required: false`
*/
where?: WhereOptions
/**
* If true, converts to an inner join, which means that the parent model will only be loaded if it has any
* matching children. True if `include.where` is set, false otherwise.
*/
required?: boolean
/**
* Limit include. Only available when setting `separate` to true.
*/
limit?: number
/**
* Run include in separate queries.
*/
separate?: boolean
/**
* Through Options
*/
through?: IncludeThroughOptions
/**
* Load further nested related models
*/
include?: Includeable[]
/**
* Order include. Only available when setting `separate` to true.
*/
order?: Order
/**
* Use sub queries. This should only be used if you know for sure the query does not result in a cartesian product.
*/
subQuery?: boolean
}
export type OrderItem =
| string
| Fn
| Col
| Literal
| [string | Col | Fn | Literal, string]
| [typeof Model | { model: typeof Model; as: string }, string, string]
| [typeof Model, typeof Model, string, string]
export type Order = string | Fn | Col | Literal | OrderItem[]
export type FindAttributeOptions =
| (string | [string | Literal | Fn, string])[]
| {
exclude: string[]
include?: (string | [string | Literal | Fn, string])[]
}
| {
exclude?: string[]
include: (string | [string | Literal | Fn, string])[]
}
/**
* Options that are passed to any model creating a SELECT query
*
* A hash of options to describe the scope of the search
*/
export interface FindOptions extends Logging, Transactionable, Filterable, Projectable, Paranoid {
/**
* A list of associations to eagerly load using a left join. Supported is either
* `{ include: [ Model1, Model2, ...]}`, `{ include: [{ model: Model1, as: 'Alias' }]}` or
* `{ include: [{ all: true }]}`.
* If your association are set up with an `as` (eg. `X.hasMany(Y, { as: 'Z }`, you need to specify Z in
* the as attribute when eager loading Y).
*/
include?: Includeable[]
/**
* Specifies an ordering. If a string is provided, it will be escaped. Using an array, you can provide
* several columns / functions to order by. Each element can be further wrapped in a two-element array. The
* first element is the column / function to order by, the second is the direction. For example:
* `order: [['name', 'DESC']]`. In this way the column will be escaped, but the direction will not.
*/
order?: Order
/**
* GROUP BY in sql
*/
group?: GroupOption
/**
* Limit the results
*/
limit?: number
/**
* Skip the results;
*/
offset?: number
/**
* Lock the selected rows. Possible options are transaction.LOCK.UPDATE and transaction.LOCK.SHARE.
* Postgres also supports transaction.LOCK.KEY_SHARE, transaction.LOCK.NO_KEY_UPDATE and specific model
* locks with joins. See [transaction.LOCK for an example](transaction#lock)
*/
lock?: string | { level: string; of: typeof Model }
/**
* Return raw result. See sequelize.query for more information.
*/
raw?: boolean
/**
* having ?!?
*/
having?: WhereAttributeHash
/**
* Use sub queries (internal)
*/
subQuery?: boolean
}
export interface NonNullFindOptions extends FindOptions {
/**
* Throw if nothing was found.
*/
rejectOnEmpty: boolean
}
/**
* Options for Model.count method
*/
export interface CountOptions extends Logging, Transactionable, Filterable, Projectable {
/**
* Include options. See `find` for details
*/
include?: Includeable[]
/**
* Apply COUNT(DISTINCT(col))
*/
distinct?: boolean
/**
* GROUP BY in sql
* Used in conjunction with `attributes`.
* @see Projectable
*/
group?: GroupOption
}
export interface FindAndCountOptions extends CountOptions, FindOptions {}
/**
* Options for Model.build method
*/
export interface BuildOptions {
/**
* If set to true, values will ignore field and virtual setters.
*/
raw?: boolean
/**
* Is this record new
*/
isNewRecord?: boolean
/**
* an array of include options - Used to build prefetched/included model instances. See `set`
*
* TODO: See set
*/
include?: Includeable[]
}
export interface Silent {
/**
* If true, the updatedAt timestamp will not be updated.
*
* Defaults to false
*/
silent?: boolean
}
/**
* Options for Model.create method
*/
export interface CreateOptions extends BuildOptions, Logging, Silent, Transactionable {
/**
* If set, only columns matching those in fields will be saved
*/
fields?: string[]
/**
* On Duplicate
*/
onDuplicate?: string
}
/**
* Options for Model.findOrInitialize method
*/
export interface FindOrInitializeOptions extends Logging, Transactionable {
/**
* A hash of search attributes.
*/
where: WhereOptions
/**
* Default values to use if building a new instance
*/
defaults?: object
}
/**
* Options for Model.upsert method
*/
export interface UpsertOptions extends Logging, Transactionable, SearchPathable {
/**
* Run validations before the row is inserted
*/
validate?: boolean
/**
* The fields to insert / update. Defaults to all fields
*/
fields?: string[]
/**
* Print query execution time in milliseconds when logging SQL.
*/
benchmark?: boolean
}
/**
* Options for Model.bulkCreate method
*/
export interface BulkCreateOptions extends Logging, Transactionable {
/**
* Fields to insert (defaults to all fields)
*/
fields?: string[]
/**
* Should each row be subject to validation before it is inserted. The whole insert will fail if one row
* fails validation
*/
validate?: boolean
/**
* Run before / after bulk create hooks?
*/
hooks?: boolean
/**
* Run before / after create hooks for each individual Instance? BulkCreate hooks will still be run if
* options.hooks is true.
*/
individualHooks?: boolean
/**
* Ignore duplicate values for primary keys? (not supported by postgres)
*
* Defaults to false
*/
ignoreDuplicates?: boolean
/**
* Fields to update if row key already exists (on duplicate key update)? (only supported by mysql &
* mariadb). By default, all fields are updated.
*/
updateOnDuplicate?: string[]
/**
* Return the affected rows (only for postgres)
*/
returning?: boolean
}
/**
* The options passed to Model.destroy in addition to truncate
*/
export interface TruncateOptions extends Logging, Transactionable, Filterable {
/**
* Only used in conjuction with TRUNCATE. Truncates all tables that have foreign-key references to the
* named table, or to any tables added to the group due to CASCADE.
*
* Defaults to false;
*/
cascade?: boolean
/**
* Run before / after bulk destroy hooks?
*/
hooks?: boolean
/**
* If set to true, destroy will SELECT all records matching the where parameter and will execute before /
* after destroy hooks on each row
*/
individualHooks?: boolean
/**
* How many rows to delete
*/
limit?: number
/**
* Delete instead of setting deletedAt to current timestamp (only applicable if `paranoid` is enabled)
*/
force?: boolean
/**
* Only used in conjunction with `truncate`.
* Automatically restart sequences owned by columns of the truncated table
*/
restartIdentity?: boolean
}
/**
* Options used for Model.destroy
*/
export interface DestroyOptions extends TruncateOptions {
/**
* If set to true, dialects that support it will use TRUNCATE instead of DELETE FROM. If a table is
* truncated the where and limit options are ignored
*/
truncate?: boolean
}
/**
* Options for Model.restore
*/
export interface RestoreOptions extends Logging, Transactionable, Filterable {
/**
* Run before / after bulk restore hooks?
*/
hooks?: boolean
/**
* If set to true, restore will find all records within the where parameter and will execute before / after
* bulkRestore hooks on each row
*/
individualHooks?: boolean
/**
* How many rows to undelete
*/
limit?: number
}
/**
* Options used for Model.update
*/
export interface UpdateOptions extends Logging, Transactionable {
/**
* Options to describe the scope of the search.
*/
where: WhereOptions
/**
* Fields to update (defaults to all fields)
*/
fields?: string[]
/**
* Should each row be subject to validation before it is inserted. The whole insert will fail if one row
* fails validation.
*
* Defaults to true
*/
validate?: boolean
/**
* Run before / after bulk update hooks?
*
* Defaults to true
*/
hooks?: boolean
/**
* Whether or not to update the side effects of any virtual setters.
*
* Defaults to true
*/
sideEffects?: boolean
/**
* Run before / after update hooks?. If true, this will execute a SELECT followed by individual UPDATEs.
* A select is needed, because the row data needs to be passed to the hooks
*
* Defaults to false
*/
individualHooks?: boolean
/**
* Return the affected rows (only for postgres)
*/
returning?: boolean
/**
* How many rows to update (only for mysql and mariadb)
*/
limit?: number
}
/**
* Options used for Model.aggregate
*/
export interface AggregateOptions extends QueryOptions, Filterable, Paranoid {
/**
* The type of the result. If `field` is a field in this Model, the default will be the type of that field,
* otherwise defaults to float.
*/
dataType?: DataType
/**
* Applies DISTINCT to the field being aggregated over
*/
distinct?: boolean
}
// instance
/**
* Options used for Instance.increment method
*/
export interface IncrementDecrementOptions extends Logging, Transactionable, Silent, SearchPathable, Filterable {}
/**
* Options used for Instance.increment method
*/
export interface IncrementDecrementOptionsWithBy extends IncrementDecrementOptions {
/**
* The number to increment by
*
* Defaults to 1
*/
by?: number
}
/**
* Options used for Instance.restore method
*/
export interface InstanceRestoreOptions extends Logging, Transactionable {}
/**
* Options used for Instance.destroy method
*/
export interface InstanceDestroyOptions extends Logging, Transactionable {
/**
* If set to true, paranoid models will actually be deleted
*/
force?: boolean
}
/**
* Options used for Instance.update method
*/
export interface InstanceUpdateOptions extends SaveOptions, SetOptions, Filterable {}
/**
* Options used for Instance.set method
*/
export interface SetOptions {
/**
* If set to true, field and virtual setters will be ignored
*/
raw?: boolean
/**
* Clear all previously set data values
*/
reset?: boolean
}
/**
* Options used for Instance.save method
*/
export interface SaveOptions extends Logging, Transactionable, Silent {
/**
* An optional array of strings, representing database columns. If fields is provided, only those columns
* will be validated and saved.
*/
fields?: string[]
/**
* If false, validations won't be run.
*
* Defaults to true
*/
validate?: boolean
}
/**
* Model validations, allow you to specify format/content/inheritance validations for each attribute of the
* model.
*
* Validations are automatically run on create, update and save. You can also call validate() to manually
* validate an instance.
*
* The validations are implemented by validator.js.
*/
export interface ModelValidateOptions {
/**
* is: ["^[a-z]+$",'i'] // will only allow letters
* is: /^[a-z]+$/i // same as the previous example using real RegExp
*/
is?: string | (string | RegExp)[] | RegExp | { msg: string; args: string | (string | RegExp)[] | RegExp }
/**
* not: ["[a-z]",'i'] // will not allow letters
*/
not?: string | (string | RegExp)[] | RegExp | { msg: string; args: string | (string | RegExp)[] | RegExp }
/**
* checks for email format (foo@bar.com)
*/
isEmail?: boolean | { msg: string }
/**
* checks for url format (http://foo.com)
*/
isUrl?: boolean | { msg: string }
/**
* checks for IPv4 (129.89.23.1) or IPv6 format
*/
isIP?: boolean | { msg: string }
/**
* checks for IPv4 (129.89.23.1)
*/
isIPv4?: boolean | { msg: string }
/**
* checks for IPv6 format
*/
isIPv6?: boolean | { msg: string }
/**
* will only allow letters
*/
isAlpha?: boolean | { msg: string }
/**
* will only allow alphanumeric characters, so "_abc" will fail
*/
isAlphanumeric?: boolean | { msg: string }
/**
* will only allow numbers
*/
isNumeric?: boolean | { msg: string }
/**
* checks for valid integers
*/
isInt?: boolean | { msg: string }
/**
* checks for valid floating point numbers
*/
isFloat?: boolean | { msg: string }
/**
* checks for any numbers
*/
isDecimal?: boolean | { msg: string }
/**
* checks for lowercase
*/
isLowercase?: boolean | { msg: string }
/**
* checks for uppercase
*/
isUppercase?: boolean | { msg: string }
/**
* won't allow null
*/
notNull?: boolean | { msg: string }
/**
* only allows null
*/
isNull?: boolean | { msg: string }
/**
* don't allow empty strings
*/
notEmpty?: boolean | { msg: string }
/**
* only allow a specific value
*/
equals?: string | { msg: string }
/**
* force specific substrings
*/
contains?: string | { msg: string }
/**
* check the value is not one of these
*/
notIn?: string[][] | { msg: string; args: string[][] }
/**
* check the value is one of these
*/
isIn?: string[][] | { msg: string; args: string[][] }
/**
* don't allow specific substrings
*/
notContains?: string[] | string | { msg: string; args: string[] | string }
/**
* only allow values with length between 2 and 10
*/
len?: [number, number] | { msg: string; args: [number, number] }
/**
* only allow uuids
*/
isUUID?: number | { msg: string; args: number }
/**
* only allow date strings
*/
isDate?: boolean | { msg: string; args: boolean }
/**
* only allow date strings after a specific date
*/
isAfter?: string | { msg: string; args: string }
/**
* only allow date strings before a specific date
*/
isBefore?: string | { msg: string; args: string }
/**
* only allow values
*/
max?: number | { msg: string; args: number }
/**
* only allow values >= 23
*/
min?: number | { msg: string; args: number }
/**
* only allow arrays
*/
isArray?: boolean | { msg: string; args: boolean }
/**
* check for valid credit card numbers
*/
isCreditCard?: boolean | { msg: string; args: boolean }
/**
* custom validations are also possible
*
* Implementation notes :
*
* We can't enforce any other method to be a function, so :
*
* ```typescript
* [name: string] : ( value : any ) => boolean;
* ```
*
* doesn't work in combination with the properties above
*
* @see https://github.com/Microsoft/TypeScript/issues/1889
*/
[name: string]: any
}
/**
* Interface for indexes property in DefineOptions
*/