Davi Daniel Siepmann
Davi Daniel Siepmann

Reputation: 189

Typescript: Partial<MyType> with sub-properties to optional

Is it possible, in typescript, to let a method accept Partial<Something>, in a way that Something's sub-properties are all set to optional too?

export interface ISomething {
    user: IUser;
}
export interface IUser {
    id: number;
    name: string;
}

export const myMethod = (something: Partial<ISomething>): void => {};

myMethod({ user: { id: 1, name: "" } });   //this works

myMethod({ user: { id: 1 } });             //this doesn't (but I want this to work too)

many thanks ;)

Upvotes: 0

Views: 330

Answers (1)

bugs
bugs

Reputation: 15323

You are essentially looking for some sort of deep partial mapped type, something like

 type DeepOptional<T> = T extends object
    ? DeepOptionalObject<T>
    : T | undefined

type DeepOptionalObject<T> = { [P in keyof T]?: DeepOptional<T[P]> }

type Foo = { bar: Bar }
type Bar = { a: number, b: boolean[] }

const f1: Partial<Foo> = { bar: { a: 1 } } // NOPE
const f2: DeepOptional<Foo> = { bar: {a: 1 } } // OK

Playground link

Upvotes: 2

Related Questions