jsdocs

Author: joaotonaco

src/structures/object.ts

@@ -3,16 +3,27 @@ import { type MimeType, MimeTypeUtil } from "../utils/mimetype";
 import { parseObjectUrl } from "../utils/object-url";
 
 export class BlobObject {
+	/** The id of the object */
 	id: string;
+	/** The url to view or download the object */
 	url: string;
+	/** The name of the object */
 	name: string;
+	/** The prefix of the object (Optional) */
 	prefix?: string;
+	/** The hash of the object */
 	hash: string;
+	/** The id of the user who created the object */
 	userId: string;
+	/** The file extension of the object */
 	extension: string;
+	/** The MIME type of the object */
 	mimeType: MimeType;
+	/** The size of the object in bytes */
 	size: number;
+	/** The expiration date of the object (Only available using `objects.list`) */
 	expiresAt?: Date;
+	/** The creation date of the object (Only available using `objects.list`) */
 	createdAt?: Date;
 
 	constructor(data: BlobObjectData) {

src/utils/mimetype/index.ts

@@ -2,13 +2,9 @@ import { type MimeType, mimeTypes, mimeTypesWithExtension } from "./mimetypes";
 
 // biome-ignore lint/complexity/noStaticOnlyClass: organization
 export class MimeTypeUtil {
-	/**
-	 * Supported mime types with their extensions
-	 */
+	/** Supported mime types with their extensions */
 	static mimeTypesWithExtension = mimeTypesWithExtension;
-	/**
-	 * All supported mime types
-	 */
+	/** All supported mime types */
 	static mimeTypes = mimeTypes;
 
 	/**

src/validation/schemas/list.ts

@@ -1,7 +1,9 @@
 import { z } from "zod";
 
 export const listObjectsSchema = z.object({
+	/** Filter by prefix */
 	prefix: z.string().optional(),
+	/** Return objects after this token */
 	continuationToken: z.string().optional(),
 });