Skip to content

Commit

Permalink
docs: Add new exported helpers to the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
PolariTOON committed Nov 29, 2022
1 parent c6b9a49 commit d536b79
Showing 1 changed file with 120 additions and 0 deletions.
120 changes: 120 additions & 0 deletions docs/api/cozy-client/modules/models.file.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,66 @@

## Functions

### computeExpirationDate

**computeExpirationDate**(`file`): `Date` | `null`

*Parameters*

| Name | Type | Description |
| :------ | :------ | :------ |
| `file` | `IOCozyFile` | io.cozy.files document |

*Returns*

`Date` | `null`

*Defined in*

[packages/cozy-client/src/models/file.js:667](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L667)

***

### computeExpirationNoticeDate

**computeExpirationNoticeDate**(`file`): `Date` | `null`

*Parameters*

| Name | Type | Description |
| :------ | :------ | :------ |
| `file` | `IOCozyFile` | io.cozy.files document |

*Returns*

`Date` | `null`

*Defined in*

[packages/cozy-client/src/models/file.js:703](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L703)

***

### computeExpirationNoticeLink

**computeExpirationNoticeLink**(`file`): `string` | `null`

*Parameters*

| Name | Type | Description |
| :------ | :------ | :------ |
| `file` | `IOCozyFile` | io.cozy.files document |

*Returns*

`string` | `null`

*Defined in*

[packages/cozy-client/src/models/file.js:721](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L721)

***

### doMobileUpload

**doMobileUpload**(`client`, `fileURL`, `options`): `Promise`<`any`>
Expand Down Expand Up @@ -411,6 +471,66 @@ Whether the file is client-side encrypted

***

### isExpired

**isExpired**(`file`): `boolean`

*Parameters*

| Name | Type | Description |
| :------ | :------ | :------ |
| `file` | `IOCozyFile` | io.cozy.files document |

*Returns*

`boolean`

*Defined in*

[packages/cozy-client/src/models/file.js:738](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L738)

***

### isExpiring

**isExpiring**(`file`): `boolean`

*Parameters*

| Name | Type | Description |
| :------ | :------ | :------ |
| `file` | `IOCozyFile` | io.cozy.files document |

*Returns*

`boolean`

*Defined in*

[packages/cozy-client/src/models/file.js:650](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L650)

***

### isExpiringSoon

**isExpiringSoon**(`file`): `boolean`

*Parameters*

| Name | Type | Description |
| :------ | :------ | :------ |
| `file` | `IOCozyFile` | io.cozy.files document |

*Returns*

`boolean`

*Defined in*

[packages/cozy-client/src/models/file.js:749](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L749)

***

### isFromKonnector

**isFromKonnector**(`file`): `boolean`
Expand Down

0 comments on commit d536b79

Please sign in to comment.