Skip to content

Commit fea6bcb

Browse files
SDK-2574 Update IDV no media content typing (#514)
1 parent 6603b27 commit fea6bcb

File tree

4 files changed

+6
-10
lines changed

4 files changed

+6
-10
lines changed

src/client/idv.client.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,7 @@ class IDVClient {
7171
* @param {string} sessionId
7272
* @param {string} mediaId
7373
*
74-
* @typedef {import('../data_type/media.js')} Media
75-
*
76-
* @returns {Promise<Media>}
74+
* @returns {Promise<import('../data_type/media.js') | null>}
7775
*/
7876
getMediaContent(sessionId, mediaId) {
7977
return this.idvService.getMediaContent(sessionId, mediaId);

src/idv_service/idv.service.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ class IDVService {
152152
* @param {string} sessionId
153153
* @param {string} mediaId
154154
*
155-
* @returns {Promise<Media>}
155+
* @returns {Promise<Media | null>}
156156
*/
157157
getMediaContent(sessionId, mediaId) {
158158
Validation.isString(sessionId, 'sessionId');

types/src/client/idv.client.d.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,9 @@ declare class IDVClient {
5555
* @param {string} sessionId
5656
* @param {string} mediaId
5757
*
58-
* @typedef {import('../data_type/media.js')} Media
59-
*
60-
* @returns {Promise<Media>}
58+
* @returns {Promise<import('../data_type/media.js') | null>}
6159
*/
62-
getMediaContent(sessionId: string, mediaId: string): Promise<import("../data_type/media.js")>;
60+
getMediaContent(sessionId: string, mediaId: string): Promise<import('../data_type/media.js') | null>;
6361
/**
6462
* Deletes media related to a Yoti IDV session based
6563
* on the supplied media ID

types/src/idv_service/idv.service.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ declare class IDVService {
4949
* @param {string} sessionId
5050
* @param {string} mediaId
5151
*
52-
* @returns {Promise<Media>}
52+
* @returns {Promise<Media | null>}
5353
*/
54-
getMediaContent(sessionId: string, mediaId: string): Promise<Media>;
54+
getMediaContent(sessionId: string, mediaId: string): Promise<Media | null>;
5555
/**
5656
* Deletes media content for a given session and media ID
5757
*

0 commit comments

Comments
 (0)