Skip to main content

BinaryParameters

@webda/core • Readme | API


Class: BinaryParameters

Interface to specify the Service parameters

Extends​

Constructors​

new BinaryParameters(params, _service)​

new BinaryParameters(params, _service): BinaryParameters

Parameters​

• params: any

• _service: Service<ServiceParameters, Events>

Returns​

BinaryParameters

Overrides​

ServiceParameters.constructor

Source​

packages/core/src/services/binary.ts:514

Properties​

expose?​

expose?: Object

Expose the service to http

Deprecated​

will be removed in 4.0

Type declaration​

restrict?​

restrict?: Object

Restrict some APIs

restrict.create?​

restrict.create?: boolean

Restrict POST

restrict.delete?​

restrict.delete?: boolean

Restrict DELETE

restrict.get?​

restrict.get?: boolean

Restrict GET

restrict.metadata?​

restrict.metadata?: boolean

Restrict update of metadata

url​

url: string

URL to expose the service to

Source​

packages/core/src/services/binary.ts:486


map​

map: Object

Define the map to Object collection

key is a Store name the string[] represent all valids attributes to store files in

Deprecated​

Index signature​

[key: string]: string[]

Source​

packages/core/src/services/binary.ts:473


models​

models: Object

Define the map of models

  • indicates all models

key is a Store name the string[] represent all valids attributes to store files in * indicates all attributes

Index signature​

[key: string]: string[]

Source​

packages/core/src/services/binary.ts:481


openapi?​

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore​

Inherited from​

ServiceParameters.openapi

Source​

packages/core/src/services/service.ts:260


type​

type: string

Type of the service

Inherited from​

ServiceParameters.type

Source​

packages/core/src/services/service.ts:251


url?​

url?: string

URL on which to serve the content

Inherited from​

ServiceParameters.url

Source​

packages/core/src/services/service.ts:255