@plugable-io/js 0.0.7 → 0.0.9

package/README.md

@@ -106,6 +106,30 @@ const response = await client.list({
 console.log('Files:', response.files);
 ```
 
+#### Ordering Results
+
+You can order files by `created_at`, `name`, or `byte_size`. The default ordering is `created_at` in descending order (newest first).
+
+```typescript
+// Order by name (ascending)
+const response = await client.list({
+  order_by: 'name',
+  order_direction: 'asc'
+});
+
+// Order by file size (descending - largest first)
+const response = await client.list({
+  order_by: 'byte_size',
+  order_direction: 'desc'
+});
+
+// Order by creation date (ascending - oldest first)
+const response = await client.list({
+  order_by: 'created_at',
+  order_direction: 'asc'
+});
+```
+
 ### Finding a File
 
 You can find a single file using `find`. This is a convenience method that searches for files and returns the first match. It's useful for finding files by metadata or other criteria.

package/dist/index.d.mts

@@ -33,6 +33,8 @@ interface SearchOptions {
     page?: number;
     per_page?: number;
     with_download_url?: boolean;
+    order_by?: 'created_at' | 'name' | 'byte_size';
+    order_direction?: 'asc' | 'desc';
 }
 interface UploadOptions {
     metadata?: Record<string, any>;

package/dist/index.d.ts

@@ -33,6 +33,8 @@ interface SearchOptions {
     page?: number;
     per_page?: number;
     with_download_url?: boolean;
+    order_by?: 'created_at' | 'name' | 'byte_size';
+    order_direction?: 'asc' | 'desc';
 }
 interface UploadOptions {
     metadata?: Record<string, any>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@plugable-io/js",
-    "version": "0.0.7",
+    "version": "0.0.9",
     "description": "JavaScript client for Plugable File Management API",
     "main": "dist/index.js",
     "module": "dist/index.mjs",
@@ -39,5 +39,6 @@
         "@types/spark-md5": "^3.0.4",
         "tsup": "^8.0.0",
         "typescript": "^5.0.0"
-    }
+    },
+    "readme": "README.md"
 }