@amityco/ts-sdk 0.0.1-beta.2 → 0.0.1-c58e50d.0

package/dist/file/api/getFile.d.ts

@@ -0,0 +1,32 @@
+/**
+ * ```js
+ * import { getFile } from '@amityco/ts-sdk'
+ * const file = await getFile('foo')
+ * ```
+ *
+ * Fetches a {@link Amity.File} object
+ *
+ * @param filelId the ID of the {@link Amity.File} to fetch
+ * @returns the associated {@link Amity.File} object
+ *
+ * @category File API
+ * @async
+ */
+export declare const getFile: {
+    <T extends Amity.FileType = any>(fileId: Amity.File<any>['fileId']): Promise<Amity.FilePayload<T>>;
+    /**
+     * ```js
+     * import { getFile } from '@amityco/ts-sdk'
+     * const file = getFile.locally('foo')
+     * ```
+     *
+     * Fetches a {@link Amity.File} object from cache
+     *
+     * @param fileId the ID of the {@link Amity.File} to fetch
+     * @returns the associated {@link Amity.File} object
+     *
+     * @category File API
+     */
+    locally(fileId: Amity.File<any>['fileId']): Amity.File<any>;
+};
+//# sourceMappingURL=getFile.d.ts.map

package/dist/file/api/index.d.ts

@@ -0,0 +1,5 @@
+export * from './getFile';
+export * from './createFile';
+export * from './deleteFile';
+export * from './fileUrlWithSize';
+//# sourceMappingURL=index.d.ts.map

package/dist/file/observers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './observeFile';
+//# sourceMappingURL=index.d.ts.map

package/dist/file/observers/observeFile.d.ts

@@ -0,0 +1,20 @@
+/**
+ * ```js
+ * import { observeFile } from '@amityco/ts-sdk'
+ *
+ * let file = {}
+ * const dispose = observeFile(fileId, updated => file = updated)
+ * ```
+ *
+ * Observe all mutation on a given {@link Amity.File}
+ *
+ * @param fileId the ID of the file to observe
+ * @param callback the function to call when new data are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the file
+ *
+ * @category File Observer
+ */
+export declare const observeFile: <Events extends ["onFetch"]>(fileId: string, callback: Amity.ObjectListener<{
+    data?: Amity.File<any> | undefined;
+} & Amity.QueryMetadata, Events>) => Amity.Unsubscriber;
+//# sourceMappingURL=observeFile.d.ts.map