mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
2113856740
* Small fix * - fixed KnockoutMappingOptions wrong typing. - overhall of typing. - add JSDoc. - add Undocumented when method doesn't have documentation. - complete new tests. * Small fixes for tslint * Modification to tslint rules * Changes to match tslint rules * Improve KnockoutObservableType with Conditional Typings. - Upped TS version - Removed semicolons, changed to double quotes - Better formating * Mapping of object of type 'any' returns 'any' - Instead of returning KnockoutObservableType<any> that is useless * Remove some rules not working as expected * Remove duplicate not needed any more * Small fixes * Small improvement in documentation * Remove knockout.mapping plugin tests. * Remove knockout.mapping plugin tests. * Small fix Co-Authored-By: Ron Buckton <ron.buckton@microsoft.com> * Support for more Primitives. Remove Primitive type from global * Small simplification * Add support for ReadonlyArray * Formatting * Reverted quote to maintain consistency with new prettier formating rules in repo. * Remove bigint. Not supported in TS 2.8
176 lines
7.1 KiB
TypeScript
176 lines
7.1 KiB
TypeScript
////////////////////////////////
|
|
// variable tests and definitions
|
|
interface User {
|
|
firstName: string
|
|
age: number
|
|
address: Address
|
|
}
|
|
|
|
interface Address {
|
|
street: string
|
|
}
|
|
|
|
interface MappedUser {
|
|
firstName: KnockoutObservable<string>
|
|
age: KnockoutObservable<number>
|
|
address: MappedAddress
|
|
}
|
|
|
|
interface MappedAddress {
|
|
street: KnockoutObservable<string>
|
|
}
|
|
|
|
interface Car {
|
|
name: string
|
|
maintenance: ReadonlyArray<number>
|
|
drivers: User[]
|
|
}
|
|
|
|
interface MappedCar {
|
|
name: KnockoutObservable<string>
|
|
maintenance: KnockoutReadonlyObservableArray<number>
|
|
drivers: KnockoutObservableArray<MappedUser>
|
|
}
|
|
|
|
let badUserMappingOptions: KnockoutMappingOptions<User> = {
|
|
ignore: ['age'],
|
|
include: ['name'],
|
|
copy: ['height'],
|
|
mappedProperties: ['age', 'name'],
|
|
deferEvaluation: false,
|
|
create: (options: KnockoutMappingCreateOptions) => { }, // $ExpectError
|
|
}
|
|
|
|
let userMappingOptions: KnockoutMappingOptions<User> = {
|
|
ignore: ['age'],
|
|
include: ['name'],
|
|
copy: ['height'],
|
|
mappedProperties: ['age', 'name'],
|
|
deferEvaluation: false,
|
|
firstName: { create: (options: KnockoutMappingCreateOptions) => { } },
|
|
}
|
|
let badMapping = {
|
|
ignof3efere: ['age'],
|
|
inclfefeude: ['name'],
|
|
}
|
|
|
|
////////////////////////////////
|
|
// fromJS function with JS object without Array properties
|
|
let userInput: User = { firstName: 'foo', age: 12, address: { street: 'street name' } }
|
|
|
|
let mappedUserViewModel: MappedUser = mapping.fromJS(userInput) // $ExpectType KnockoutObservableType<User>
|
|
mappedUserViewModel.age // $ExpectType KnockoutObservable<number>
|
|
|
|
mapping.fromJS(userInput, {}) // $ExpectType KnockoutObservableType<User>
|
|
mapping.fromJS(userInput, {}, mappedUserViewModel) // $ExpectType KnockoutObservableType<User>
|
|
mapping.fromJS(userInput, mappedUserViewModel) // $ExpectType KnockoutObservableType<User>
|
|
mapping.fromJS(userInput, userMappingOptions, mappedUserViewModel) // $ExpectType KnockoutObservableType<User>
|
|
mapping.fromJS(userInput, {}, userInput) // $ExpectError
|
|
mapping.fromJS(userInput, userInput) // $ExpectError
|
|
|
|
let untypedObject: any = { age: 22 }
|
|
mapping.fromJS(untypedObject) // $ExpectType any
|
|
|
|
////////////////////////////////
|
|
// fromJS function with JS object with Array properties
|
|
let carInput: Car = { name: 'hb20x', maintenance: [1, 2], drivers: [userInput] }
|
|
let mappedCar: MappedCar = mapping.fromJS(carInput)
|
|
let drivers: KnockoutObservableArray<MappedUser> = mappedCar.drivers
|
|
let maintenance: KnockoutReadonlyObservableArray<number> = mappedCar.maintenance
|
|
|
|
////////////////////////////////
|
|
// fromJS function with primitives
|
|
let numberInput: number
|
|
let stringInput: string
|
|
let booleanInput: boolean
|
|
let symbolInput: symbol
|
|
|
|
mapping.fromJS(numberInput) // $ExpectType KnockoutObservable<number>
|
|
mapping.fromJS(stringInput) // $ExpectType KnockoutObservable<string>
|
|
mapping.fromJS(symbolInput) // $ExpectType KnockoutObservable<symbol>
|
|
|
|
// Typescript weirdly returns KnockoutObservable<false> | KnockoutObservable<true>
|
|
let booleanMapped: KnockoutObservable<boolean> = mapping.fromJS(booleanInput)
|
|
|
|
////////////////////////////////
|
|
// fromJS function with JS Array
|
|
let userArrayInput = [userInput]
|
|
let untypedArrayObject: any[]
|
|
let numberArrayInput: number[]
|
|
|
|
mapping.fromJS(userArrayInput) // $ExpectType KnockoutObservableArray<KnockoutObservableType<User>>
|
|
mapping.fromJS(userArrayInput, {}) // $ExpectType KnockoutObservableArray<KnockoutObservableType<User>>
|
|
mapping.fromJS(userArrayInput, {}, userArrayInput) // $ExpectError
|
|
|
|
// Could not solve this issue. Could not get his to return any when T is any. It returns a Union type of the possible values.
|
|
mapping.fromJS(untypedArrayObject) // $ExpectType KnockoutObservableArray<any> | KnockoutObservableArray<KnockoutObservableType<any>>
|
|
|
|
let mappedNumberArrayViewModel = mapping.fromJS(numberArrayInput) // $ExpectType KnockoutObservableArray<number>
|
|
mapping.fromJS(numberArrayInput, {}, mappedNumberArrayViewModel) // $ExpectType KnockoutObservableArray<number>
|
|
mapping.fromJS(numberArrayInput, mappedNumberArrayViewModel) // $ExpectType KnockoutObservableArray<number>
|
|
|
|
////////////////////////////////
|
|
// fromJS function with JS ReadonlyArray
|
|
let userReadonlyArrayInput: ReadonlyArray<User>
|
|
let numberReadonlyArray: ReadonlyArray<number>
|
|
|
|
mapping.fromJS(userReadonlyArrayInput) // $ExpectType KnockoutReadonlyObservableArray<KnockoutObservableType<User>>
|
|
mapping.fromJS(userReadonlyArrayInput, {}) // $ExpectType KnockoutReadonlyObservableArray<KnockoutObservableType<User>>
|
|
mapping.fromJS(userReadonlyArrayInput, {}, userArrayInput) // $ExpectError
|
|
|
|
let mappedNumberReadonlyArrayViewModel = mapping.fromJS(numberReadonlyArray) // $ExpectType KnockoutReadonlyObservableArray<number>
|
|
mapping.fromJS(numberReadonlyArray, {}, mappedNumberReadonlyArrayViewModel) // $ExpectType KnockoutReadonlyObservableArray<number>
|
|
mapping.fromJS(numberReadonlyArray, mappedNumberReadonlyArrayViewModel) // $ExpectType KnockoutReadonlyObservableArray<number>
|
|
|
|
////////////////////////////////
|
|
// fromJSON function
|
|
interface nameObject {
|
|
name: string
|
|
}
|
|
|
|
let nameObjectInput: nameObject = { name: 'bar' }
|
|
let nameObjectInputJSON = '{ name: "foo" }'
|
|
|
|
mapping.fromJSON(nameObjectInputJSON) // $ExpectType any
|
|
mapping.fromJSON(nameObjectInputJSON, {}) // $ExpectType any
|
|
mapping.fromJSON(nameObjectInputJSON, nameObjectInput) // $ExpectType any
|
|
mapping.fromJSON(nameObjectInputJSON, {}, nameObjectInput) // $ExpectType any
|
|
|
|
let userInputJSON = "{ firstName: 'foo', age: 12 }"
|
|
mapping.fromJSON(userInputJSON, userMappingOptions, mappedUserViewModel) // $ExpectType any
|
|
|
|
////////////////////////////////
|
|
// toJS function
|
|
|
|
mapping.toJS<User>(mappedUserViewModel) // $ExpectType User
|
|
mapping.toJS<User>(mappedUserViewModel, {}) // $ExpectType User
|
|
|
|
// Here the method isn't typed literally, it has implicit type. Unfortunatly the typing fails to properly type object properties that are object themselves.
|
|
// Could not solve this issue.
|
|
let unmmapedUser: User = mapping.toJS(mappedUserViewModel) // $ExpectError
|
|
|
|
mapping.toJS<number>(mappedUserViewModel) // $ExpectError
|
|
mapping.toJS<User>(stringInput) // $ExpectError
|
|
|
|
mapping.toJS(ko.observable(2)) // $ExpectType number
|
|
mapping.toJS(mappedNumberArrayViewModel) // $ExpectType number[]
|
|
mapping.toJS(untypedObject) // $ExpectType any
|
|
mapping.toJS(ko.observableArray(untypedArrayObject)) // $ExpectType any[]
|
|
|
|
|
|
////////////////////////////////
|
|
// toJSON function
|
|
mapping.toJSON(nameObjectInput) // $ExpectType string
|
|
mapping.toJSON(nameObjectInput, {}) // $ExpectType string
|
|
mapping.toJSON<MappedUser>(mappedUserViewModel, userMappingOptions) // $ExpectType string
|
|
|
|
////////////////////////////////
|
|
// visitModel function
|
|
mapping.visitModel(nameObjectInput, (x: any) => x, {})
|
|
mapping.visitModel(nameObjectInput, (x: any) => x, { visitedObjects: null })
|
|
mapping.visitModel(nameObjectInput, (x: any) => x, { parentName: 'parent' })
|
|
mapping.visitModel(nameObjectInput, (x: any) => x, { ignore: ['age'] })
|
|
mapping.visitModel(nameObjectInput, (x: any) => x, { copy: ['height'] })
|
|
mapping.visitModel(nameObjectInput, (x: any) => x, { include: ['name'] })
|
|
mapping.visitModel(nameObjectInput, (x: any) => x, { visitedObjects: null, parentName: 'parent', ignore: ['age'], copy: ['height'], include: ['name'] })
|