Skip to content

Type definitions of field values in dts-gen is not accurate #1593

@safu9

Description

@safu9

Versions

  • @kintone/dts-gen: 6.1.3
  • TypeScript: 4.7.4

Current Behavior

Types of some field values are defined as string, but can be undefined according to the document.
Also we are allowed to assign null to the fields.

Fields that can be undefined and null

  • Text (kintone.fieldTypes.SingleLineText)
  • Text Area (kintone.fieldTypes.MultiLineText)
  • Number (kintone.fieldTypes.Number)
  • Drop-down (kintone.fieldTypes.DropDown)
  • Date (kintone.fieldTypes.Date)
  • Time (kintone.fieldTypes.Time)
  • Date and time (kintone.fieldTypes.DateTime)
  • Link (kintone.fieldTypes.Link)

Fields that can be null

  • Rich Text (kintone.fieldTypes.RichText)

Expected Behavior

Types of these field values shoud be defined as string | undefined | null or string | null, not string.

Steps to reproduce the issue

When strict option in tsconfig is true, this code should not have any error, but do.

const field : kintone.fieldTypes.SingleLineText = { value: null };

This code should have a error at value.trim(), but don't.

const trimedValue = field.value.trim();

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingpkg: dts-gen@kintone/dts-gen

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions