🔖 @hugginface/hub v0.5.0

Author: machineuser

README.md

@@ -49,7 +49,7 @@ You can run our packages with vanilla JS, without any bundler, by using a CDN or
 
 <script type="module">
     import { HfInference } from 'https://cdn.jsdelivr.net/npm/@huggingface/[email protected]/+esm';
-    import { createRepo, commit, deleteRepo, listFiles } from "https://cdn.jsdelivr.net/npm/@huggingface/hub@0.4.0/+esm";
+    import { createRepo, commit, deleteRepo, listFiles } from "https://cdn.jsdelivr.net/npm/@huggingface/hub@0.5.0/+esm";
 </script>
 ```
 

docs/hub/README.md

@@ -12,9 +12,9 @@ For some of the calls, you need to create an account and generate an [access tok
 
 ```ts
 import { createRepo, uploadFiles, deleteFile, deleteRepo, listFiles, whoAmI } from "@huggingface/hub";
-import type { RepoId, Credentials } from "@huggingface/hub";
+import type { RepoDesignation, Credentials } from "@huggingface/hub";
 
-const repo: RepoId = { type: "model", name: "myname/some-model" };
+const repo: RepoDesignation = { type: "model", name: "myname/some-model" };
 const credentials: Credentials = { accessToken: "hf_..." };
 
 const {name: username} = await whoAmI({credentials});

docs/hub/interfaces/CommitDeletedEntry.md

@@ -8,7 +8,7 @@
 
 #### Defined in
 
-[hub/src/lib/commit.ts:28](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L28)
+[hub/src/lib/commit.ts:29](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L29)
 
 ___
 
@@ -18,4 +18,4 @@ ___
 
 #### Defined in
 
-[hub/src/lib/commit.ts:29](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L29)
+[hub/src/lib/commit.ts:30](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L30)

docs/hub/interfaces/CommitFile.md

@@ -8,7 +8,7 @@
 
 #### Defined in
 
-[hub/src/lib/commit.ts:37](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L37)
+[hub/src/lib/commit.ts:38](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L38)
 
 ___
 
@@ -18,7 +18,7 @@ ___
 
 #### Defined in
 
-[hub/src/lib/commit.ts:35](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L35)
+[hub/src/lib/commit.ts:36](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L36)
 
 ___
 
@@ -28,4 +28,4 @@ ___
 
 #### Defined in
 
-[hub/src/lib/commit.ts:36](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L36)
+[hub/src/lib/commit.ts:37](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L37)

docs/hub/interfaces/CommitOutput.md

@@ -15,7 +15,7 @@
 
 #### Defined in
 
-[hub/src/lib/commit.ts:75](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L75)
+[hub/src/lib/commit.ts:76](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L76)
 
 ___
 
@@ -25,7 +25,7 @@ ___
 
 #### Defined in
 
-[hub/src/lib/commit.ts:79](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L79)
+[hub/src/lib/commit.ts:80](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L80)
 
 ___
 
@@ -35,4 +35,4 @@ ___
 
 #### Defined in
 
-[hub/src/lib/commit.ts:74](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L74)
+[hub/src/lib/commit.ts:75](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L75)

docs/hub/interfaces/CommitParams.md

@@ -12,7 +12,7 @@
 
 #### Defined in
 
-[hub/src/lib/commit.ts:61](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L61)
+[hub/src/lib/commit.ts:62](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L62)
 
 ___
 
@@ -22,7 +22,7 @@ ___
 
 #### Defined in
 
-[hub/src/lib/commit.ts:59](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L59)
+[hub/src/lib/commit.ts:60](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L60)
 
 ___
 
@@ -32,7 +32,7 @@ ___
 
 #### Defined in
 
-[hub/src/lib/commit.ts:56](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L56)
+[hub/src/lib/commit.ts:57](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L57)
 
 ___
 
@@ -42,7 +42,7 @@ ___
 
 #### Defined in
 
-[hub/src/lib/commit.ts:70](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L70)
+[hub/src/lib/commit.ts:71](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L71)
 
 ___
 
@@ -52,7 +52,7 @@ ___
 
 #### Defined in
 
-[hub/src/lib/commit.ts:69](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L69)
+[hub/src/lib/commit.ts:70](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L70)
 
 ___
 
@@ -62,7 +62,7 @@ ___
 
 #### Defined in
 
-[hub/src/lib/commit.ts:58](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L58)
+[hub/src/lib/commit.ts:59](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L59)
 
 ___
 
@@ -77,17 +77,17 @@ Parent commit. Optional
 
 #### Defined in
 
-[hub/src/lib/commit.ts:68](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L68)
+[hub/src/lib/commit.ts:69](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L69)
 
 ___
 
 ### repo
 
-• **repo**: [`RepoId`](RepoId)
+• **repo**: [`RepoDesignation`](../modules#repodesignation)
 
 #### Defined in
 
-[hub/src/lib/commit.ts:57](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L57)
+[hub/src/lib/commit.ts:58](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L58)
 
 ___
 
@@ -97,4 +97,4 @@ ___
 
 #### Defined in
 
-[hub/src/lib/commit.ts:55](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L55)
+[hub/src/lib/commit.ts:56](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L56)

docs/hub/interfaces/Credentials.md

@@ -8,4 +8,4 @@
 
 #### Defined in
 
-[hub/src/types/public.d.ts:12](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.d.ts#L12)
+[hub/src/types/public.d.ts:16](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.d.ts#L16)

docs/hub/interfaces/FileDownloadInfoOutput.md

@@ -10,7 +10,7 @@ In case of LFS file, link to download directly from cloud provider
 
 #### Defined in
 
-[hub/src/lib/file-download-info.ts:12](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/file-download-info.ts#L12)
+[hub/src/lib/file-download-info.ts:13](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/file-download-info.ts#L13)
 
 ___
 
@@ -20,7 +20,7 @@ ___
 
 #### Defined in
 
-[hub/src/lib/file-download-info.ts:8](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/file-download-info.ts#L8)
+[hub/src/lib/file-download-info.ts:9](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/file-download-info.ts#L9)
 
 ___
 
@@ -30,4 +30,4 @@ ___
 
 #### Defined in
 
-[hub/src/lib/file-download-info.ts:7](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/file-download-info.ts#L7)
+[hub/src/lib/file-download-info.ts:8](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/file-download-info.ts#L8)

docs/hub/interfaces/ListFileEntry.md

@@ -8,7 +8,7 @@
 
 #### Defined in
 
-[hub/src/lib/list-files.ts:19](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L19)
+[hub/src/lib/list-files.ts:20](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L20)
 
 ___
 
@@ -26,7 +26,7 @@ ___
 
 #### Defined in
 
-[hub/src/lib/list-files.ts:13](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L13)
+[hub/src/lib/list-files.ts:14](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L14)
 
 ___
 
@@ -36,7 +36,7 @@ ___
 
 #### Defined in
 
-[hub/src/lib/list-files.ts:12](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L12)
+[hub/src/lib/list-files.ts:13](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L13)
 
 ___
 
@@ -46,7 +46,7 @@ ___
 
 #### Defined in
 
-[hub/src/lib/list-files.ts:11](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L11)
+[hub/src/lib/list-files.ts:12](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L12)
 
 ___
 
@@ -56,7 +56,7 @@ ___
 
 #### Defined in
 
-[hub/src/lib/list-files.ts:24](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L24)
+[hub/src/lib/list-files.ts:25](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L25)
 
 ___
 
@@ -66,7 +66,7 @@ ___
 
 #### Defined in
 
-[hub/src/lib/list-files.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L10)
+[hub/src/lib/list-files.ts:11](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L11)
 
 ___
 
@@ -76,4 +76,4 @@ ___
 
 #### Defined in
 
-[hub/src/lib/list-files.ts:9](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L9)
+[hub/src/lib/list-files.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L10)

docs/hub/interfaces/SpaceResourceConfig.md

@@ -8,7 +8,7 @@
 
 #### Defined in
 
-[hub/src/types/public.d.ts:115](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.d.ts#L115)
+[hub/src/types/public.d.ts:119](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.d.ts#L119)
 
 ___
 
@@ -18,7 +18,7 @@ ___
 
 #### Defined in
 
-[hub/src/types/public.d.ts:112](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.d.ts#L112)
+[hub/src/types/public.d.ts:116](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.d.ts#L116)
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-[hub/src/types/public.d.ts:113](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.d.ts#L113)
+[hub/src/types/public.d.ts:117](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.d.ts#L117)
 
 ___
 
@@ -38,7 +38,7 @@ ___
 
 #### Defined in
 
-[hub/src/types/public.d.ts:111](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.d.ts#L111)
+[hub/src/types/public.d.ts:115](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.d.ts#L115)
 
 ___
 
@@ -48,4 +48,4 @@ ___
 
 #### Defined in
 
-[hub/src/types/public.d.ts:114](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.d.ts#L114)
+[hub/src/types/public.d.ts:118](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.d.ts#L118)