Email field is required but marked as nullable in ICalAttendeeData type

[koenigstag]

ical-generator version: 3.6.1

Recently tested simple email with attendees and discovered that none of falsy values are valid for email field in attendees array.

interface ICalAttendeeData {
  ...
  email?: string | null;
  ...
}

Tested values are: undefined, null, "" (empty string).
Example code

attendees: [
  {
    name: "Test User",
    email: null
  }
]

This example gives an error:
"No value for `email` in ICalAttendee given!"

CodeSandbox:
https://codesandbox.io/s/express-typescript-example-forked-94ujl7?file=/src/routes.ts

[sebbo2002]

This is sadly true for all mandatory fields in ical-generator. The reason for this is that ical-generator has always allowed you to use the setters, in this case email() for example, and you are not required to include all the data with the constructor. This is currently absolutely valid code, for example:

const attendee = event.createAttendee();
attendee.email('foo@bar.com');

I understand that this is a bit weird, but I hope that the exceptions is meaningful enough. For the next breaking version it is already planned that at least the mandatory fields have to be passed to achieve some security here.

[sebbo2002]

I just pushed a preview of ical-generator v6 to develop, which should fix this issue. I would be happy if you could test the new version and give me some feedback. You can install the version with npm i ical-generator@next. All changes in this release can be found here.