Find
Media search endpoint.
type ApiFindFunction = (args: ApiFindRequest, opts?: JobOptions) => Promise<DataOrError<ApiFindResponse>>
/**
* A request for the find endpoint of an
* Api.
*/
interface ApiFindRequest {
excludeDeleted?: boolean
ids?: OrArray<string>
includeInfo?: boolean
max?: number
next?: number
prefix?: string
sort?: number
source?: string
type?: MediaType
updatedSince?: number
user?: string
}
/**
* A response from the find endpoint of an
* Api.
*/
interface ApiFindResponse {
count?: number
media: Array<StoredMedia>
next?: number
updatedAt?: number
}
type FindResponse<T extends LocaledMedia | StoredMedia = StoredMedia> = T extends LocaledMedia ? LocalApiFindResponse : ApiFindResponse
interface LocalApiFindResponse {
count?: number
media: Array<LocaledMedia>
next?: number
updatedAt?: number
}
function apiFindInMedia<T = StoredMedia | LocaledMedia>(
media: Array<T>,
normalized: ApiFindRequest
): FindResponse<T>