1
0
mirror of https://github.com/oceanprotocol/ocean.js.git synced 2024-11-26 20:39:05 +01:00
ocean.js/docs/interfaces/Service.md
2023-05-02 18:18:30 +01:00

2.8 KiB

@oceanprotocol/lib / Exports / Service

Interface: Service

Table of contents

Properties

Properties

additionalInformation

Optional additionalInformation: any

Stores service specific additional information, this is customizable by publisher

Defined in

@types/DDO/Service.ts:109


compute

Optional compute: ServiceComputeOptions

If service is of type compute, holds information about the compute-related privacy settings & resources.

Defined in

@types/DDO/Service.ts:103


datatokenAddress

datatokenAddress: string

Datatoken address

Defined in

@types/DDO/Service.ts:73


description

Optional description: string

Service description

Defined in

@types/DDO/Service.ts:97


files

files: string

Encrypted file URLs.

Defined in

@types/DDO/Service.ts:67


id

id: string

Unique ID

Defined in

@types/DDO/Service.ts:55


name

Optional name: string

Service friendly name

Defined in

@types/DDO/Service.ts:91


serviceEndpoint

serviceEndpoint: string

Provider URL (schema + host).

Defined in

@types/DDO/Service.ts:79


timeout

timeout: number

Describing how long the service can be used after consumption is initiated.

Defined in

@types/DDO/Service.ts:85


type

type: string

Type of service (access, compute, wss.

Defined in

@types/DDO/Service.ts:61