Skip to content

Commit e0689b5

Browse files
authored
feat(javascript): add exactOptionalPropertyTypes to tsconfig (#4935)
1 parent 8db88fd commit e0689b5

File tree

26 files changed

+76
-72
lines changed

26 files changed

+76
-72
lines changed

clients/algoliasearch-client-javascript/packages/client-common/src/createIterablePromise.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export function createIterablePromise<TResponse>({
1717
error,
1818
timeout = (): number => 0,
1919
}: CreateIterablePromise<TResponse>): Promise<TResponse> {
20-
const retry = (previousResponse?: TResponse): Promise<TResponse> => {
20+
const retry = (previousResponse?: TResponse | undefined): Promise<TResponse> => {
2121
return new Promise<TResponse>((resolve, reject) => {
2222
func(previousResponse)
2323
.then(async (response) => {

clients/algoliasearch-client-javascript/packages/client-common/src/logger/createNullLogger.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ import type { Logger } from '../types/logger';
22

33
export function createNullLogger(): Logger {
44
return {
5-
debug(_message: string, _args?: any): Promise<void> {
5+
debug(_message: string, _args?: any | undefined): Promise<void> {
66
return Promise.resolve();
77
},
8-
info(_message: string, _args?: any): Promise<void> {
8+
info(_message: string, _args?: any | undefined): Promise<void> {
99
return Promise.resolve();
1010
},
11-
error(_message: string, _args?: any): Promise<void> {
11+
error(_message: string, _args?: any | undefined): Promise<void> {
1212
return Promise.resolve();
1313
},
1414
};

clients/algoliasearch-client-javascript/packages/client-common/src/transporter/errors.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,12 @@ export type DetailedErrorWithMessage = {
7676
export type DetailedErrorWithTypeID = {
7777
id: string;
7878
type: string;
79-
name?: string;
79+
name?: string | undefined;
8080
};
8181

8282
export type DetailedError = {
8383
code: string;
84-
details?: DetailedErrorWithMessage[] | DetailedErrorWithTypeID[];
84+
details?: DetailedErrorWithMessage[] | DetailedErrorWithTypeID[] | undefined;
8585
};
8686

8787
// DetailedApiError is only used by the ingestion client to return more informative error, other clients will use ApiClient.

clients/algoliasearch-client-javascript/packages/client-common/src/transporter/helpers.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ export function serializeData(request: Request, requestOptions: RequestOptions):
5656
export function serializeHeaders(
5757
baseHeaders: Headers,
5858
requestHeaders: Headers,
59-
requestOptionsHeaders?: Headers,
59+
requestOptionsHeaders?: Headers | undefined,
6060
): Headers {
6161
const headers: Headers = {
6262
Accept: 'application/json',

clients/algoliasearch-client-javascript/packages/client-common/src/types/cache.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ export type Cache = {
55
get: <TValue>(
66
key: Record<string, any> | string,
77
defaultValue: () => Promise<TValue>,
8-
events?: CacheEvents<TValue>,
8+
events?: CacheEvents<TValue> | undefined,
99
) => Promise<TValue>;
1010

1111
/**
@@ -35,7 +35,7 @@ export type MemoryCacheOptions = {
3535
/**
3636
* If keys and values should be serialized using `JSON.stringify`.
3737
*/
38-
serializable?: boolean;
38+
serializable?: boolean | undefined;
3939
};
4040

4141
export type BrowserLocalStorageOptions = {
@@ -47,12 +47,12 @@ export type BrowserLocalStorageOptions = {
4747
/**
4848
* The time to live for each cached item in seconds.
4949
*/
50-
timeToLive?: number;
50+
timeToLive?: number | undefined;
5151

5252
/**
5353
* The native local storage implementation.
5454
*/
55-
localStorage?: Storage;
55+
localStorage?: Storage | undefined;
5656
};
5757

5858
export type BrowserLocalStorageCacheItem = {

clients/algoliasearch-client-javascript/packages/client-common/src/types/createClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ export type CreateClientOptions = Omit<TransporterOptions, OverriddenTransporter
88
Partial<Pick<TransporterOptions, OverriddenTransporterOptions>> & {
99
appId: string;
1010
apiKey: string;
11-
authMode?: AuthMode;
11+
authMode?: AuthMode | undefined;
1212
algoliaAgents: AlgoliaAgentOptions[];
1313
};
1414

clients/algoliasearch-client-javascript/packages/client-common/src/types/createIterablePromise.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export type CreateIterablePromise<TResponse> = IterableOptions<TResponse> & {
3131
*
3232
* The `previousResponse` parameter (`undefined` on the first call) allows you to build your request with incremental logic, to iterate on `page` or `cursor` for example.
3333
*/
34-
func: (previousResponse?: TResponse) => Promise<TResponse>;
34+
func: (previousResponse?: TResponse | undefined) => Promise<TResponse>;
3535

3636
/**
3737
* The validator function. It receive the resolved return of the API call.

clients/algoliasearch-client-javascript/packages/client-common/src/types/host.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export type Host = {
1717
/**
1818
* The port of the host URL.
1919
*/
20-
port?: number;
20+
port?: number | undefined;
2121
};
2222

2323
export type StatefulHost = Host & {

clients/algoliasearch-client-javascript/packages/client-common/src/types/logger.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ export type Logger = {
1010
/**
1111
* Logs debug messages.
1212
*/
13-
debug: (message: string, args?: any) => Promise<void>;
13+
debug: (message: string, args?: any | undefined) => Promise<void>;
1414

1515
/**
1616
* Logs info messages.
1717
*/
18-
info: (message: string, args?: any) => Promise<void>;
18+
info: (message: string, args?: any | undefined) => Promise<void>;
1919

2020
/**
2121
* Logs error messages.
2222
*/
23-
error: (message: string, args?: any) => Promise<void>;
23+
error: (message: string, args?: any | undefined) => Promise<void>;
2424
};

clients/algoliasearch-client-javascript/packages/client-common/src/types/requester.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@ export type Request = {
1414
*/
1515
path: string;
1616
queryParameters: QueryParameters;
17-
data?: Array<Record<string, any>> | Record<string, any>;
17+
data?: Array<Record<string, any>> | Record<string, any> | undefined;
1818
headers: Headers;
1919
/**
2020
* If the given request should persist on the cache. Keep in mind,
2121
* that some methods may have this option enabled by default.
2222
*/
23-
cacheable?: boolean;
23+
cacheable?: boolean | undefined;
2424
/**
2525
* Some POST methods in the Algolia REST API uses the `read` transporter.
2626
* This information is defined at the spec level.
2727
*/
28-
useReadTransporter?: boolean;
28+
useReadTransporter?: boolean | undefined;
2929
};
3030

3131
export type EndRequest = Pick<Request, 'headers' | 'method'> & {
@@ -41,7 +41,7 @@ export type EndRequest = Pick<Request, 'headers' | 'method'> & {
4141
* The response timeout, in milliseconds.
4242
*/
4343
responseTimeout: number;
44-
data?: string;
44+
data?: string | undefined;
4545
};
4646

4747
export type Response = {

0 commit comments

Comments
 (0)