kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-05-19 05:03:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #21557 from dankraus/string-base64-typings

Browse Source 
Joi - Adds string base64 typings
This commit is contained in:
Armando Aguirre
2017-11-28 16:37:35 -08:00
committed by GitHub
parent e9430decb9 0c20cfdcd9
commit 8dc08f71c4
2 changed files with 68 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
types/joi/index.d.ts vendored
View File

@@ -8,6 +8,7 @@
// Rytis Alekna <https://github.com/ralekna>
// Pavel Ivanov <https://github.com/schfkt>
// Youngrok Kim <https://github.com/rokoroku>
// Dan Kraus <https://github.com/dankraus>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.4
@@ -127,6 +128,13 @@ export interface UriOptions {
scheme?: string | RegExp | Array<string | RegExp>;
}
export interface Base64Options {
/**
* optional parameter defaulting to true which will require = padding if true or make padding optional if false
*/
paddingRequired?: boolean;
}
export interface WhenOptions {
/**
* the required condition joi type.
@@ -520,6 +528,12 @@ export interface StringSchema extends AnySchema {
*/
normalize(form?: 'NFC' | 'NFD' | 'NFKC' | 'NFKD'): this;
/**
* Requires the string value to be a valid base64 string; does not check the decoded value.
* @param options - optional settings: The unicode normalization options to use. Valid values: NFC [default], NFD, NFKC, NFKD
*/
base64(options?: Base64Options): this;
/**
* Requires the number to be a credit card number (Using Lunh Algorithm).
*/

99
types/joi/joi-tests.ts
View File

@@ -1,51 +1,52 @@
import Joi = require('joi');
import { GuidVersions } from 'joi';
// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
var x: any = null;
var value: any = null;
var num: number = 0;
var str: string = '';
var bool: boolean = false;
var exp: RegExp = null;
var obj: object = null;
var date: Date = null;
var err: Error = null;
var func: Function = null;
let x: any = null;
let value: any = null;
let num: number = 0;
let str: string = '';
let bool: boolean = false;
let exp: RegExp = null;
let obj: object = null;
let date: Date = null;
let err: Error = null;
let func: Function = null;
var anyArr: any[] = [];
var numArr: number[] = [];
var strArr: string[] = [];
var boolArr: boolean[] = [];
var expArr: RegExp[] = [];
var objArr: object[] = [];
var errArr: Error[] = [];
var funcArr: Function[] = [];
let anyArr: any[] = [];
let numArr: number[] = [];
let strArr: string[] = [];
let boolArr: boolean[] = [];
let expArr: RegExp[] = [];
let objArr: object[] = [];
let errArr: Error[] = [];
let funcArr: Function[] = [];
// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
var schema: Joi.Schema = null;
var schemaLike: Joi.SchemaLike = null;
let schema: Joi.Schema = null;
let schemaLike: Joi.SchemaLike = null;
var anySchema: Joi.AnySchema = null;
var numSchema: Joi.NumberSchema = null;
var strSchema: Joi.StringSchema = null;
var arrSchema: Joi.ArraySchema = null;
var boolSchema: Joi.BooleanSchema = null;
var binSchema: Joi.BinarySchema = null;
var dateSchema: Joi.DateSchema = null;
var funcSchema: Joi.FunctionSchema = null;
var objSchema: Joi.ObjectSchema = null;
var altSchema: Joi.AlternativesSchema = null;
let anySchema: Joi.AnySchema = null;
let numSchema: Joi.NumberSchema = null;
let strSchema: Joi.StringSchema = null;
let arrSchema: Joi.ArraySchema = null;
let boolSchema: Joi.BooleanSchema = null;
let binSchema: Joi.BinarySchema = null;
let dateSchema: Joi.DateSchema = null;
let funcSchema: Joi.FunctionSchema = null;
let objSchema: Joi.ObjectSchema = null;
let altSchema: Joi.AlternativesSchema = null;
var schemaArr: Joi.Schema[] = [];
let schemaArr: Joi.Schema[] = [];
var ref: Joi.Reference = null;
var description: Joi.Description = null;
let ref: Joi.Reference = null;
let description: Joi.Description = null;
// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
var validOpts: Joi.ValidationOptions = null;
let validOpts: Joi.ValidationOptions = null;
validOpts = { abortEarly: bool };
validOpts = { convert: bool };
@@ -77,7 +78,7 @@ validOpts = {
// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
var renOpts: Joi.RenameOptions = null;
let renOpts: Joi.RenameOptions = null;
renOpts = { alias: bool };
renOpts = { multiple: bool };
@@ -86,7 +87,7 @@ renOpts = { ignoreUndefined: bool };
// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
var emailOpts: Joi.EmailOptions = null;
let emailOpts: Joi.EmailOptions = null;
emailOpts = { errorLevel: num };
emailOpts = { errorLevel: bool };
@@ -96,7 +97,7 @@ emailOpts = { minDomainAtoms: num };
// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
var ipOpts: Joi.IpOptions = null;
let ipOpts: Joi.IpOptions = null;
ipOpts = { version: str };
ipOpts = { version: strArr };
@@ -104,7 +105,7 @@ ipOpts = { cidr: str };
// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
var uriOpts: Joi.UriOptions = null;
let uriOpts: Joi.UriOptions = null;
uriOpts = { scheme: str };
uriOpts = { scheme: exp };
@@ -113,7 +114,13 @@ uriOpts = { scheme: expArr };
// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
var whenOpts: Joi.WhenOptions = null;
let base64Opts: Joi.Base64Options = null;
base64Opts = { paddingRequired: bool };
// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
let whenOpts: Joi.WhenOptions = null;
whenOpts = { is: x };
whenOpts = { is: schema, then: schema };
@@ -122,16 +129,16 @@ whenOpts = { is: schemaLike, then: schemaLike, otherwise: schemaLike };
// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
var refOpts: Joi.ReferenceOptions = null;
let refOpts: Joi.ReferenceOptions = null;
refOpts = { separator: str };
refOpts = { contextPrefix: str };
// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
var validErr: Joi.ValidationError = null;
var validErrItem: Joi.ValidationErrorItem;
var validErrFunc: Joi.ValidationErrorFunction;
let validErr: Joi.ValidationError = null;
let validErrItem: Joi.ValidationErrorItem;
let validErrFunc: Joi.ValidationErrorFunction;
validErrItem = {
message: str,
@@ -176,7 +183,7 @@ anySchema = objSchema;
// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
var schemaMap: Joi.SchemaMap = null;
let schemaMap: Joi.SchemaMap = null;
schemaMap = {
a: numSchema,
@@ -765,7 +772,7 @@ strSchema = strSchema.ip(ipOpts);
strSchema = strSchema.uri();
strSchema = strSchema.uri(uriOpts);
strSchema = strSchema.guid();
strSchema = strSchema.guid({ version: ['uuidv1', 'uuidv2', 'uuidv3', 'uuidv4', 'uuidv5'] });
strSchema = strSchema.guid({ version: ['uuidv1' as GuidVersions, 'uuidv2' as GuidVersions, 'uuidv3' as GuidVersions, 'uuidv4' as GuidVersions, 'uuidv5' as GuidVersions]});
strSchema = strSchema.guid({ version: 'uuidv4' });
strSchema = strSchema.hex();
strSchema = strSchema.hostname();
@@ -777,6 +784,8 @@ strSchema = strSchema.truncate();
strSchema = strSchema.truncate(false);
strSchema = strSchema.normalize();
strSchema = strSchema.normalize('NFKC');
strSchema = strSchema.base64();
strSchema = strSchema.base64(base64Opts);
namespace common {
strSchema = strSchema.allow(x);