Skip to content

Commit

Permalink
docs: update JSDoc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Prithpal-Sooriya committed Sep 20, 2024
1 parent 7ccbf59 commit 4c59338
Showing 1 changed file with 13 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ export const getMockUserStorageEndpoint = (
};

/**
* Temp
* @param data - foo
* @returns bar
* Creates a mock GET user-storage response
* @param data - data to encrypt
* @returns a realistic GET Response Body
*/
export async function createMockGetStorageResponse(
data?: string,
Expand All @@ -48,9 +48,9 @@ export async function createMockGetStorageResponse(
}

/**
* Temp
* @param dataArr - foo
* @returns bar
* Creates a mock GET ALL user-storage response
* @param dataArr - array of data to encrypt
* @returns a realistic GET ALL Response Body
*/
export async function createMockAllFeatureEntriesResponse(
dataArr: string[] = [MOCK_STORAGE_DATA],
Expand All @@ -67,9 +67,9 @@ export async function createMockAllFeatureEntriesResponse(
}

/**
* Temp
* @param path - foo
* @returns bar
* Creates a mock user-storage api GET request
* @param path - path of the GET Url
* @returns mock GET API request. Can be used by e2e or unit mock servers
*/
export async function getMockUserStorageGetResponse(
path: UserStoragePathWithFeatureAndKey = 'notifications.notification_settings',
Expand All @@ -82,10 +82,10 @@ export async function getMockUserStorageGetResponse(
}

/**
* Temp
* @param path - foo
* @param dataArr - bar
* @returns baz
* Creates a mock user-storage api GET ALL request
* @param path - path of the GET url
* @param dataArr - data to encrypt
* @returns mock GET ALL API request. Can be used by e2e or unit mock servers
*/
export async function getMockUserStorageAllFeatureEntriesResponse(
path: UserStoragePathWithFeatureOnly = 'notifications',
Expand Down

0 comments on commit 4c59338

Please sign in to comment.