types: ensure props are readonly

This commit is contained in:
Evan You 2019-11-09 18:40:25 -05:00
parent a5f962ab8e
commit 08bf9976ae
4 changed files with 28 additions and 15 deletions

View File

@ -14,7 +14,10 @@ import { VNodeProps } from './vnode'
// overload 1: direct setup function // overload 1: direct setup function
// (uses user defined props interface) // (uses user defined props interface)
export function createComponent<Props, RawBindings = object>( export function createComponent<Props, RawBindings = object>(
setup: (props: Props, ctx: SetupContext) => RawBindings | RenderFunction setup: (
props: Readonly<Props>,
ctx: SetupContext
) => RawBindings | RenderFunction
): { ): {
new (): ComponentPublicInstance< new (): ComponentPublicInstance<
Props, Props,

View File

@ -83,7 +83,7 @@ export type ComponentOptionsWithoutProps<
M extends MethodOptions = {} M extends MethodOptions = {}
> = ComponentOptionsBase<Props, RawBindings, D, C, M> & { > = ComponentOptionsBase<Props, RawBindings, D, C, M> & {
props?: undefined props?: undefined
} & ThisType<ComponentPublicInstance<{}, RawBindings, D, C, M, Props>> } & ThisType<ComponentPublicInstance<{}, RawBindings, D, C, M, Readonly<Props>>>
export type ComponentOptionsWithArrayProps< export type ComponentOptionsWithArrayProps<
PropNames extends string = string, PropNames extends string = string,
@ -91,7 +91,7 @@ export type ComponentOptionsWithArrayProps<
D = {}, D = {},
C extends ComputedOptions = {}, C extends ComputedOptions = {},
M extends MethodOptions = {}, M extends MethodOptions = {},
Props = { [key in PropNames]?: any } Props = Readonly<{ [key in PropNames]?: any }>
> = ComponentOptionsBase<Props, RawBindings, D, C, M> & { > = ComponentOptionsBase<Props, RawBindings, D, C, M> & {
props: PropNames[] props: PropNames[]
} & ThisType<ComponentPublicInstance<Props, RawBindings, D, C, M>> } & ThisType<ComponentPublicInstance<Props, RawBindings, D, C, M>>
@ -102,7 +102,7 @@ export type ComponentOptionsWithObjectProps<
D = {}, D = {},
C extends ComputedOptions = {}, C extends ComputedOptions = {},
M extends MethodOptions = {}, M extends MethodOptions = {},
Props = ExtractPropTypes<PropsOptions> Props = Readonly<ExtractPropTypes<PropsOptions>>
> = ComponentOptionsBase<Props, RawBindings, D, C, M> & { > = ComponentOptionsBase<Props, RawBindings, D, C, M> & {
props: PropsOptions props: PropsOptions
} & ThisType<ComponentPublicInstance<Props, RawBindings, D, C, M>> } & ThisType<ComponentPublicInstance<Props, RawBindings, D, C, M>>

View File

@ -65,14 +65,8 @@ export type ExtractPropTypes<
O, O,
MakeDefaultRequired extends boolean = true MakeDefaultRequired extends boolean = true
> = O extends object > = O extends object
? { ? { [K in RequiredKeys<O, MakeDefaultRequired>]: InferPropType<O[K]> } &
readonly [K in RequiredKeys<O, MakeDefaultRequired>]: InferPropType<O[K]> { [K in OptionalKeys<O, MakeDefaultRequired>]?: InferPropType<O[K]> }
} &
{
readonly [K in OptionalKeys<O, MakeDefaultRequired>]?: InferPropType<
O[K]
>
}
: { [K in string]: any } : { [K in string]: any }
const enum BooleanFlags { const enum BooleanFlags {

View File

@ -71,6 +71,9 @@ describe('with object props', () => {
expectType<ExpectedProps['ccc']>(props.ccc) expectType<ExpectedProps['ccc']>(props.ccc)
expectType<ExpectedProps['ddd']>(props.ddd) expectType<ExpectedProps['ddd']>(props.ddd)
// props should be readonly
expectError((props.a = 1))
// should also expose declared props on `this` // should also expose declared props on `this`
expectType<ExpectedProps['a']>(this.a) expectType<ExpectedProps['a']>(this.a)
expectType<ExpectedProps['b']>(this.b) expectType<ExpectedProps['b']>(this.b)
@ -80,10 +83,16 @@ describe('with object props', () => {
expectType<ExpectedProps['ccc']>(this.ccc) expectType<ExpectedProps['ccc']>(this.ccc)
expectType<ExpectedProps['ddd']>(this.ddd) expectType<ExpectedProps['ddd']>(this.ddd)
// props on `this` should be readonly
expectError((this.a = 1))
// assert setup context unwrapping // assert setup context unwrapping
expectType<number>(this.c) expectType<number>(this.c)
expectType<string>(this.d.e) expectType<string>(this.d.e)
// setup context properties should be mutable
this.c = 2
return null return null
} }
}) })
@ -126,6 +135,9 @@ describe('type inference w/ optional props declaration', () => {
}, },
render() { render() {
expectType<string>(this.$props.msg) expectType<string>(this.$props.msg)
// props should be readonly
expectError((this.$props.msg = 'foo'))
// should not expose on `this`
expectError(this.msg) expectError(this.msg)
expectType<number>(this.a) expectType<number>(this.a)
return null return null
@ -148,14 +160,18 @@ describe('type inference w/ array props declaration', () => {
createComponent({ createComponent({
props: ['a', 'b'], props: ['a', 'b'],
setup(props) { setup(props) {
props.a // props should be readonly
props.b expectError((props.a = 1))
expectType<any>(props.a)
expectType<any>(props.b)
return { return {
c: 1 c: 1
} }
}, },
render() { render() {
expectType<{ a?: any; b?: any }>(this.$props) expectType<any>(this.$props.a)
expectType<any>(this.$props.b)
expectError((this.$props.a = 1))
expectType<any>(this.a) expectType<any>(this.a)
expectType<any>(this.b) expectType<any>(this.b)
expectType<number>(this.c) expectType<number>(this.c)