Skip to content
This repository was archived by the owner on May 19, 2025. It is now read-only.
This repository was archived by the owner on May 19, 2025. It is now read-only.

TypeScript Error: key does not exist on type Range #439

Description

@mateja176

Subject of the issue

Describe your issue here.

This is a type error, meaning that it does not impact the module's runtime. The prop key is missing in interface Range.

[BUG] Bug Reproduce Steps

Tell us how to reproduce this issue.

The above assumption is backed by the following evidence:

export interface CommonCalendarProps {
  onChange?: (range: OnChangeProps) => void;
  // ...
}

export type OnChangeProps = Range | { selection: Range } | Date;

export interface Range {
    /** default: today */
    startDate?: Date;
    /** default: today */
    endDate?: Date;
}

Whereas at runtime:

<DateRangePicker
  onChange={(item) => {
    if ('selection' in item) {
        setRange(item.selection); // { startDate: 'foo', endDate: 'bar', key: 'selection' }
    }
  }}
  // ...
/>

[BUG] Expected behaviour

The Range interface should be expanded to include the key. Like so:

export interface Range {
    /** default: today */
    startDate?: Date;
    /** default: today */
    endDate?: Date;
  key?: 'selection';
}

Perhaps a better alternative is to adjust the OnChangeProps type to:

export type OnChangeProps = Range | { selection: Range & { key: 'selection' } } | Date;

Environment

Package Version: 1.1.3
React version: 16.9
Node version: 14
Browser: Chrome

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions