fix(types): use exact optional property types

Author: rexxars

package.config.ts

@@ -4,6 +4,8 @@ import {visualizer} from 'rollup-plugin-visualizer'
 import {name, version} from './package.json'
 
 export default defineConfig({
+  tsconfig: './tsconfig.build.json',
+
   extract: {
     rules: {
       'tsdoc-undefined-tag': 'off',

src/errors.ts

@@ -18,17 +18,17 @@ export class ParseError extends Error {
   /**
    * In the case of an unknown field encountered in the stream, this will be the field name.
    */
-  field?: string
+  field?: string | undefined
 
   /**
    * In the case of an unknown field encountered in the stream, this will be the value of the field.
    */
-  value?: string
+  value?: string | undefined
 
   /**
    * The line that caused the error, if available.
    */
-  line?: string
+  line?: string | undefined
 
   constructor(
     message: string,

src/stream.ts

@@ -16,21 +16,21 @@ export interface StreamOptions {
    *
    * @defaultValue `undefined`
    */
-  onError?: 'terminate' | ((error: Error) => void)
+  onError?: ('terminate' | ((error: Error) => void)) | undefined
 
   /**
    * Callback for when a reconnection interval is sent from the server.
    *
    * @param retry - The number of milliseconds to wait before reconnecting.
    */
-  onRetry?: (retry: number) => void
+  onRetry?: ((retry: number) => void) | undefined
 
   /**
    * Callback for when a comment is encountered in the stream.
    *
    * @param comment - The comment encountered in the stream.
    */
-  onComment?: (comment: string) => void
+  onComment?: ((comment: string) => void) | undefined
 }
 
 /**

src/types.ts

@@ -11,7 +11,7 @@ export interface EventSourceParser {
   /**
    * Feeds the parser another chunk. The method _does not_ return a parsed message.
    * Instead, callbacks passed when creating the parser will be triggered once we see enough data
-   * for a valid/invalid parsing step (see @link {ParserCallbacks}).
+   * for a valid/invalid parsing step (see {@link ParserCallbacks}).
    *
    * @param chunk - The chunk to parse. Can be a partial, eg in the case of streaming messages.
    * @public
@@ -43,13 +43,13 @@ export interface EventSourceMessage {
    * implementation in that browsers will default this to `message`, whereas this parser will
    * leave this as `undefined` if not explicitly declared.
    */
-  event?: string
+  event?: string | undefined
 
   /**
    * ID of the message, if any was provided by the server. Can be used by clients to keep the
    * last received message ID in sync when reconnecting.
    */
-  id?: string
+  id?: string | undefined
 
   /**
    * The data received for this message
@@ -70,21 +70,21 @@ export interface ParserCallbacks {
    *
    * @param event - The parsed event/message
    */
-  onEvent?: (event: EventSourceMessage) => void
+  onEvent?: ((event: EventSourceMessage) => void) | undefined
 
   /**
    * Callback for when the server sends a new reconnection interval through the `retry` field.
    *
    * @param retry - The number of milliseconds to wait before reconnecting.
    */
-  onRetry?: (retry: number) => void
+  onRetry?: ((retry: number) => void) | undefined
 
   /**
    * Callback for when a comment is encountered in the stream.
    *
    * @param comment - The comment encountered in the stream.
    */
-  onComment?: (comment: string) => void
+  onComment?: ((comment: string) => void) | undefined
 
   /**
    * Callback for when an error occurs during parsing. This is a catch-all for any errors
@@ -93,5 +93,5 @@ export interface ParserCallbacks {
    *
    * @param error - The error that occurred during parsing
    */
-  onError?: (error: ParseError) => void
+  onError?: ((error: ParseError) => void) | undefined
 }

test/mock.ts

@@ -3,9 +3,9 @@ import {expect, vi} from 'vitest'
 import type {EventSourceMessage, ParserCallbacks} from '../src/types.ts'
 
 interface MessageMatcher {
-  id?: string | RegExp
-  event?: string
-  data?: string | RegExp
+  id?: string | RegExp | undefined
+  event?: string | undefined
+  data?: string | RegExp | undefined
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types

test/parse.test.ts

@@ -325,15 +325,15 @@ test('stream with huge data chunks', async () => {
   const parser = createParser({onEvent: mock.onParse})
   await getHugeMessageFixtureStream(parser.feed)
   const hugeMsg = mock.events[0]
-  if (hugeMsg.type !== 'event') {
+  if (!hugeMsg || hugeMsg.type !== 'event') {
     throw new Error('First message was not an event')
   }
 
   expect(hugeMsg.data.length).toBe(4808512)
 
   const receivedHash = createHash('sha256').update(hugeMsg.data).digest('hex')
   const hashMsg = mock.events[1]
-  if (hashMsg.type !== 'event') {
+  if (!hashMsg || hashMsg.type !== 'event') {
     throw new Error('Second message was not an event')
   }
 
@@ -387,7 +387,7 @@ test('calls onError when the stream is invalid but not newline-terminated (throu
   expect(onEvent).not.toHaveBeenCalled()
   expect(onError).toHaveBeenCalled()
 
-  const error = onError.mock.calls[0][0]
+  const error = onError.mock.calls[0]?.[0]
   expect(error).toBeInstanceOf(ParseError)
   expect(error).toMatchObject({
     type: 'unknown-field',
@@ -411,7 +411,7 @@ test('calls onError when the stream is invalid (through newline)', async () => {
   expect(onEvent).not.toHaveBeenCalled()
   expect(onError).toHaveBeenCalled()
 
-  const error = onError.mock.calls[0][0]
+  const error = onError.mock.calls[0]?.[0]
   expect(error).toBeInstanceOf(ParseError)
   expect(error).toMatchObject({
     type: 'unknown-field',
@@ -430,7 +430,7 @@ test('calls onError when the stream is invalid (no field separator)', async () =
   expect(onEvent).not.toHaveBeenCalled()
   expect(onError).toHaveBeenCalled()
 
-  const error = onError.mock.calls[0][0]
+  const error = onError.mock.calls[0]?.[0]
   expect(error).toBeInstanceOf(ParseError)
   expect(error).toMatchObject({
     type: 'unknown-field',

tsconfig.build.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noCheck": true
+  }
+}