mirror of
https://github.com/oceanprotocol/ocean.js.git
synced 2024-11-26 20:39:05 +01:00
119 lines
2.0 KiB
Markdown
119 lines
2.0 KiB
Markdown
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / FileInfo
|
|
|
|
# Interface: FileInfo
|
|
|
|
## Table of contents
|
|
|
|
### Properties
|
|
|
|
- [checksum](FileInfo.md#checksum)
|
|
- [contentLength](FileInfo.md#contentlength)
|
|
- [contentType](FileInfo.md#contenttype)
|
|
- [index](FileInfo.md#index)
|
|
- [method](FileInfo.md#method)
|
|
- [type](FileInfo.md#type)
|
|
- [url](FileInfo.md#url)
|
|
- [valid](FileInfo.md#valid)
|
|
|
|
## Properties
|
|
|
|
### checksum
|
|
|
|
• `Optional` **checksum**: `string`
|
|
|
|
Computed file checksum
|
|
|
|
#### Defined in
|
|
|
|
[@types/FileInfo.ts:43](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L43)
|
|
|
|
___
|
|
|
|
### contentLength
|
|
|
|
• `Optional` **contentLength**: `string`
|
|
|
|
File content length.
|
|
|
|
#### Defined in
|
|
|
|
[@types/FileInfo.ts:19](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L19)
|
|
|
|
___
|
|
|
|
### contentType
|
|
|
|
• `Optional` **contentType**: `string`
|
|
|
|
File format, if applicable.
|
|
|
|
**`Example`**
|
|
|
|
```ts
|
|
"text/csv"
|
|
```
|
|
|
|
#### Defined in
|
|
|
|
[@types/FileInfo.ts:13](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L13)
|
|
|
|
___
|
|
|
|
### index
|
|
|
|
• `Optional` **index**: `number`
|
|
|
|
File index.
|
|
|
|
#### Defined in
|
|
|
|
[@types/FileInfo.ts:25](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L25)
|
|
|
|
___
|
|
|
|
### method
|
|
|
|
• `Optional` **method**: `string`
|
|
|
|
HTTP method used
|
|
|
|
#### Defined in
|
|
|
|
[@types/FileInfo.ts:37](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L37)
|
|
|
|
___
|
|
|
|
### type
|
|
|
|
• **type**: `string`
|
|
|
|
File URL.
|
|
|
|
#### Defined in
|
|
|
|
[@types/FileInfo.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L6)
|
|
|
|
___
|
|
|
|
### url
|
|
|
|
• `Optional` **url**: `string`
|
|
|
|
File URL.
|
|
|
|
#### Defined in
|
|
|
|
[@types/FileInfo.ts:31](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L31)
|
|
|
|
___
|
|
|
|
### valid
|
|
|
|
• `Optional` **valid**: `boolean`
|
|
|
|
check if file exists
|
|
|
|
#### Defined in
|
|
|
|
[@types/FileInfo.ts:49](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L49)
|