Add undefined to optional properties, part S (DefinitelyTyped#54313)

In preparation for exactOptionalPropertyTypes in Typescript 4.4, add
undefined to all optional properties. #no-publishing-comment

This PR covers packages starting with s-.
microsoft/dtslint#335

Author: sandersn

types/s3-download-stream/index.d.ts

@@ -11,8 +11,8 @@ import { S3 } from "aws-sdk";
 declare namespace s3Stream {
     interface S3StreamDownloaderOptions {
         client: S3;
-        concurrency?: number;
-        chunkSize?: string;
+        concurrency?: number | undefined;
+        chunkSize?: string | undefined;
         params: S3.GetObjectRequest;
     }
 }

types/s3-streams/index.d.ts

@@ -16,7 +16,7 @@ export interface StreamOptions {
      * @default 4MB for {@link ReadStream}
      * @default 10MB for {@link WriteStream}
      */
-    highWaterMark?: number;
+    highWaterMark?: number | undefined;
 }
 
 export class ReadStream extends Readable {

types/s3-uploader/index.d.ts

@@ -9,27 +9,27 @@ export = Upload;
 
 declare namespace Upload {
     interface S3UploaderVersion {
-        original?: boolean;
-        suffix?: string;
-        quality?: number;
-        maxWidth?: number;
-        maxHeight?: number;
+        original?: boolean | undefined;
+        suffix?: string | undefined;
+        quality?: number | undefined;
+        maxWidth?: number | undefined;
+        maxHeight?: number | undefined;
     }
 
     interface S3UploaderOptions {
-        awsAccessKeyId?: string;
-        awsSecretAccessKey?: string;
-        awsBucketRegion?: string;
-        awsBucketPath?: string;
-        awsBucketAcl?: string;
-        awsMaxRetries?: number;
-        awsHttpTimeout?: number;
-        resizeQuality?: number;
-        returnExif?: boolean;
-        tmpDir?: string;
-        workers?: number;
-        url?: string;
-        versions?: S3UploaderVersion[];
+        awsAccessKeyId?: string | undefined;
+        awsSecretAccessKey?: string | undefined;
+        awsBucketRegion?: string | undefined;
+        awsBucketPath?: string | undefined;
+        awsBucketAcl?: string | undefined;
+        awsMaxRetries?: number | undefined;
+        awsHttpTimeout?: number | undefined;
+        resizeQuality?: number | undefined;
+        returnExif?: boolean | undefined;
+        tmpDir?: string | undefined;
+        workers?: number | undefined;
+        url?: string | undefined;
+        versions?: S3UploaderVersion[] | undefined;
     }
 
     interface Meta {

types/s3rver/index.d.ts

@@ -24,16 +24,16 @@ declare class S3rver {
 }
 
 interface S3rverOptions {
-    port?: number;
-    hostname?: string;
-    address?: string;
-    silent?: boolean;
-    key?: string | Buffer;
-    cert?: string | Buffer;
-    resetOnClose?: boolean;
-    indexDocument?: string;
-    errorDocument?: string;
-    configureBuckets?: S3rverBucketConfig[];
+    port?: number | undefined;
+    hostname?: string | undefined;
+    address?: string | undefined;
+    silent?: boolean | undefined;
+    key?: string | Buffer | undefined;
+    cert?: string | Buffer | undefined;
+    resetOnClose?: boolean | undefined;
+    indexDocument?: string | undefined;
+    errorDocument?: string | undefined;
+    configureBuckets?: S3rverBucketConfig[] | undefined;
     directory: string;
 }
 

types/sade/index.d.ts

@@ -19,12 +19,12 @@ declare namespace sade {
          * Optionally define one or more aliases for the current Command.
          * When declared, the `opts.alias` value is passed directly to the [`prog.alias`](#progaliasnames) method.
          */
-        alias?: string | string[];
-        default?: boolean;
+        alias?: string | string[] | undefined;
+        default?: boolean | undefined;
     }
 
     interface ParseOptions extends mri.Options {
-        lazy?: boolean;
+        lazy?: boolean | undefined;
     }
 
     interface LazyOutput {

types/safe-regex/index.d.ts

@@ -4,4 +4,4 @@
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
 export = safe_regex;
-declare function safe_regex(re: string | RegExp, opts?: { limit?: number }): boolean;
+declare function safe_regex(re: string | RegExp, opts?: { limit?: number | undefined }): boolean;

types/sails.io.js/index.d.ts

@@ -7,36 +7,36 @@
 
 declare namespace SailsIOJS {
     export interface SDKInfo {
-        version?: string;
-        language?: string;
-        platform?: "browser" | "node";
-        versionString?: string;
+        version?: string | undefined;
+        language?: string | undefined;
+        platform?: "browser" | "node" | undefined;
+        versionString?: string | undefined;
     }
     export interface ClientSails {
-        url?: string;
-        autoConnect?: boolean;
-        headers?: { [index: string]: string };
-        transports?: Array<"websocket" | "polling">;
-        rejectUnauthorized?: boolean;
-        reconnection?: boolean;
-        reconnectionAttempts?: number;
-        reconnectionDelay?: number;
-        reconnectionDelayMax?: number;
-        useCORSRouteToGetCookie?: boolean;
-        query?: string;
-        path?: string;
+        url?: string | undefined;
+        autoConnect?: boolean | undefined;
+        headers?: { [index: string]: string } | undefined;
+        transports?: Array<"websocket" | "polling"> | undefined;
+        rejectUnauthorized?: boolean | undefined;
+        reconnection?: boolean | undefined;
+        reconnectionAttempts?: number | undefined;
+        reconnectionDelay?: number | undefined;
+        reconnectionDelayMax?: number | undefined;
+        useCORSRouteToGetCookie?: boolean | undefined;
+        query?: string | undefined;
+        path?: string | undefined;
         // All logs are disabled when `io.sails.environment = 'production'`
-        environment?: "production" | string;
+        environment?: "production" | string | undefined;
         connect(url?: string, config?: ConnectConfig): Socket;
-        initialConnectionHeaders?: InitialConnectionHeaders;
-        strict?: boolean;
-        sdk?: SDKInfo;
+        initialConnectionHeaders?: InitialConnectionHeaders | undefined;
+        strict?: boolean | undefined;
+        sdk?: SDKInfo | undefined;
     }
     export interface ConnectConfig {
-        initialConnectionHeaders?: InitialConnectionHeaders
+        initialConnectionHeaders?: InitialConnectionHeaders | undefined
     }
     export interface InitialConnectionHeaders {
-        nosession?: boolean;
+        nosession?: boolean | undefined;
         [key: string]: unknown;
     }
     export interface Client {
@@ -46,16 +46,16 @@ declare namespace SailsIOJS {
     export interface Headers { [index: string]: string }
     export interface RequestOptions {
         url: string;
-        method?: string;
-        headers?: Headers;
+        method?: string | undefined;
+        headers?: Headers | undefined;
         params?: any;
         data?: any;
     }
     export interface JWR {
         headers: Headers;
         statusCode: number;
         body: any;
-        error?: Error;
+        error?: Error | undefined;
         toString: () => string;
         toPOJO: () => {
             body: any;

types/sailthru-client/index.d.ts

@@ -25,16 +25,16 @@ export interface PurchaseItem {
     price: number;
     id: string | number;
     url: string;
-    tags?: string[];
-    vars?: object;
+    tags?: string[] | undefined;
+    vars?: object | undefined;
     images?: {
         full?: {
             url: string
-        },
+        } | undefined,
         thumb?: {
             url: string
-        }
-    };
+        } | undefined
+    } | undefined;
 }
 
 export type SailthruResponse = object | string;

types/salesforce__canvas-js-sdk/index.d.ts

@@ -9,16 +9,16 @@ declare namespace Sfdc {
     namespace canvas {
         // see https://developer.salesforce.com/docs/atlas.en-us.platform_connect.meta/platform_connect/client_object.htm
         interface Client {
-            readonly oauthToken?: string | null;
-            readonly instanceId?: string | null;
-            readonly instanceUrl?: string | null;
-            readonly targetOrigin?: string | null;
-            readonly refreshToken?: string | null;
+            readonly oauthToken?: string | null | undefined;
+            readonly instanceId?: string | null | undefined;
+            readonly instanceUrl?: string | null | undefined;
+            readonly targetOrigin?: string | null | undefined;
+            readonly refreshToken?: string | null | undefined;
         }
 
         interface Response<T> {
             readonly status: number;
-            readonly payload?: T;
+            readonly payload?: T | undefined;
         }
 
         enum ApplicationOptions {
@@ -127,7 +127,7 @@ declare namespace Sfdc {
         interface Environment {
             readonly parameters: Record<string, unknown>;
             readonly dimensions: EnvironmentDimensions;
-            readonly record?: EnvironmentRecord;
+            readonly record?: EnvironmentRecord | undefined;
             readonly displayLocation: EnvironmentDisplayLocation;
             readonly locationUrl: string;
             readonly subLocation: EnvironmentDisplaySubLocation | null;
@@ -164,10 +164,10 @@ declare namespace Sfdc {
 
         // see https://developer.salesforce.com/docs/atlas.en-us.platform_connect.meta/platform_connect/context_object.htm
         interface Context {
-            readonly application?: Application;
-            readonly user?: User;
+            readonly application?: Application | undefined;
+            readonly user?: User | undefined;
             readonly environment: Environment;
-            readonly organization?: Organization;
+            readonly organization?: Organization | undefined;
             readonly links: Links;
         }
 
@@ -295,11 +295,11 @@ declare namespace Sfdc {
             interface AjaxSettings {
                 readonly client: Client;
                 readonly success: (data: Response<unknown>) => void;
-                readonly method?: string;
-                readonly async?: boolean;
-                readonly contentType?: string;
-                readonly headers?: Record<string, string>;
-                readonly data?: string | null;
+                readonly method?: string | undefined;
+                readonly async?: boolean | undefined;
+                readonly contentType?: string | undefined;
+                readonly headers?: Record<string, string> | undefined;
+                readonly data?: string | null | undefined;
             }
 
             interface Version {
@@ -405,14 +405,14 @@ declare namespace Sfdc {
                 readonly response_type: string;
                 readonly client_id: string;
                 readonly redirect_uri: string;
-                readonly state?: string;
-                readonly display?: string;
+                readonly state?: string | undefined;
+                readonly display?: string | undefined;
             }
 
             interface LoginContext {
                 readonly uri: string;
                 readonly params: LoginParams;
-                readonly callback?: string;
+                readonly callback?: string | undefined;
             }
 
             function init(): void;