Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Leo Conforti committed Oct 17, 2024
1 parent 6b1ac8a commit 852fd2d
Show file tree
Hide file tree
Showing 3 changed files with 171 additions and 6 deletions.
165 changes: 165 additions & 0 deletions docs/modules/Endpoints.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,21 @@ Added in v1.0.0
- [TasksError](#taskserror)
- [Volumes](#volumes)
- [VolumesError](#volumeserror)
- [isConfigsError](#isconfigserror)
- [isContainersError](#iscontainerserror)
- [isDistributionsError](#isdistributionserror)
- [isExecsError](#isexecserror)
- [isImagesError](#isimageserror)
- [isNetworksError](#isnetworkserror)
- [isNodesError](#isnodeserror)
- [isPluginsError](#ispluginserror)
- [isSecretsError](#issecretserror)
- [isServicesError](#isserviceserror)
- [isSessionsError](#issessionserror)
- [isSwarmsError](#isswarmserror)
- [isSystemsError](#issystemserror)
- [isTasksError](#istaskserror)
- [isVolumesError](#isvolumeserror)

---

Expand Down Expand Up @@ -349,3 +364,153 @@ export declare const VolumesError: typeof VolumesError
```
Added in v1.0.0
## isConfigsError
**Signature**
```ts
export declare const isConfigsError: (u: unknown) => u is ConfigsError
```
Added in v1.0.0
## isContainersError
**Signature**
```ts
export declare const isContainersError: (u: unknown) => u is ContainersError
```
Added in v1.0.0
## isDistributionsError
**Signature**
```ts
export declare const isDistributionsError: (u: unknown) => u is DistributionsError
```
Added in v1.0.0
## isExecsError
**Signature**
```ts
export declare const isExecsError: (u: unknown) => u is ExecsError
```
Added in v1.0.0
## isImagesError
**Signature**
```ts
export declare const isImagesError: (u: unknown) => u is ImagesError
```
Added in v1.0.0
## isNetworksError
**Signature**
```ts
export declare const isNetworksError: (u: unknown) => u is NetworksError
```
Added in v1.0.0
## isNodesError
**Signature**
```ts
export declare const isNodesError: (u: unknown) => u is NodesError
```
Added in v1.0.0
## isPluginsError
**Signature**
```ts
export declare const isPluginsError: (u: unknown) => u is PluginsError
```
Added in v1.0.0
## isSecretsError
**Signature**
```ts
export declare const isSecretsError: (u: unknown) => u is SecretsError
```
Added in v1.0.0
## isServicesError
**Signature**
```ts
export declare const isServicesError: (u: unknown) => u is ServicesError
```
Added in v1.0.0
## isSessionsError
**Signature**
```ts
export declare const isSessionsError: (u: unknown) => u is SessionsError
```
Added in v1.0.0
## isSwarmsError
**Signature**
```ts
export declare const isSwarmsError: (u: unknown) => u is SwarmsError
```
Added in v1.0.0
## isSystemsError
**Signature**
```ts
export declare const isSystemsError: (u: unknown) => u is SystemsError
```
Added in v1.0.0
## isTasksError
**Signature**
```ts
export declare const isTasksError: (u: unknown) => u is TasksError
```
Added in v1.0.0
## isVolumesError
**Signature**
```ts
export declare const isVolumesError: (u: unknown) => u is VolumesError
```
Added in v1.0.0
6 changes: 3 additions & 3 deletions docs/modules/endpoints/Execs.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Added in v1.0.0
- [ExecsError (class)](#execserror-class)
- [ExecsErrorTypeId](#execserrortypeid)
- [ExecsErrorTypeId (type alias)](#execserrortypeid-type-alias)
- [isDistributionsError](#isdistributionserror)
- [isExecsError](#isexecserror)
- [Layers](#layers)
- [layer](#layer)
- [Tags](#tags)
Expand Down Expand Up @@ -58,12 +58,12 @@ export type ExecsErrorTypeId = typeof ExecsErrorTypeId

Added in v1.0.0

## isDistributionsError
## isExecsError

**Signature**

```ts
export declare const isDistributionsError: (u: unknown) => u is ExecsError
export declare const isExecsError: (u: unknown) => u is ExecsError
```

Added in v1.0.0
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/endpoints/Images.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Added in v1.0.0
- [ImagesError (class)](#imageserror-class)
- [ImagesErrorTypeId](#imageserrortypeid)
- [ImagesErrorTypeId (type alias)](#imageserrortypeid-type-alias)
- [isDistributionsError](#isdistributionserror)
- [isImagesError](#isimageserror)
- [Layers](#layers)
- [layer](#layer)
- [Params](#params)
Expand Down Expand Up @@ -60,12 +60,12 @@ export type ImagesErrorTypeId = typeof ImagesErrorTypeId

Added in v1.0.0

## isDistributionsError
## isImagesError

**Signature**

```ts
export declare const isDistributionsError: (u: unknown) => u is ImagesError
export declare const isImagesError: (u: unknown) => u is ImagesError
```

Added in v1.0.0
Expand Down

0 comments on commit 852fd2d

Please sign in to comment.