Skip to main content

fileResponseFormatter

Workspace API

Workspace API / helpers/fileResponseFormatter

helpers/fileResponseFormatter

Functions​

formatFileResponse()​

formatFileResponse(file): object

Defined in: helpers/fileResponseFormatter.ts:7

Format a FileInfo object for API response Converts Date objects to ISO strings for JSON serialization

Parameters​

file​

FileInfo

Returns​

object

name​

name: string

path​

path: string

size​

size: number

contentType​

contentType: string

created​

created: string

updated​

updated: string

isFolder​

isFolder: boolean

metadata?​

optional metadata: Record<string, string>

formatFileResponseWithOriginal()​

formatFileResponseWithOriginal(file): object

Defined in: helpers/fileResponseFormatter.ts:33

Format a FileInfo object for API response with originalFilename Used for organization-level file listings

Parameters​

file​

FileInfo

Returns​

object

name​

name: string

path​

path: string

size​

size: number

contentType​

contentType: string

created​

created: string

updated​

updated: string

isFolder​

isFolder: boolean

metadata?​

optional metadata: Record<string, string>

originalFilename?​

optional originalFilename: string

documentId?​

optional documentId: string

processingStatus?​

optional processingStatus: string

formatFolderResponse()​

formatFolderResponse(folder): object

Defined in: helpers/fileResponseFormatter.ts:63

Format a FolderInfo object for API response Converts Date objects to ISO strings for JSON serialization

Parameters​

folder​

FolderInfo

Returns​

object

name​

name: string

path​

path: string

created​

created: string

fileCount​

fileCount: number

totalSize​

totalSize: number

formatFilesResponse()​

formatFilesResponse(files): object[]

Defined in: helpers/fileResponseFormatter.ts:82

Format an array of FileInfo objects for API response

Parameters​

files​

FileInfo[]

Returns​

object[]

formatFilesResponseWithOriginal()​

formatFilesResponseWithOriginal(files): object[]

Defined in: helpers/fileResponseFormatter.ts:89

Format an array of FileInfo objects for API response with originalFilename

Parameters​

files​

FileInfo[]

Returns​

object[]

formatFoldersResponse()​

formatFoldersResponse(folders): object[]

Defined in: helpers/fileResponseFormatter.ts:98

Format an array of FolderInfo objects for API response

Parameters​

folders​

FolderInfo[]

Returns​

object[]