Skip to main content

FileBinaryParameters

@webda/core • Readme | API


Class: FileBinaryParameters

Default binary parameters

Extends​

Constructors​

new FileBinaryParameters(params, service)​

new FileBinaryParameters(params, service): FileBinaryParameters

Parameters​

• params: any

• service: BinaryService<BinaryParameters, BinaryEvents>

Returns​

FileBinaryParameters

Overrides​

CloudBinaryParameters.constructor

Source​

packages/core/src/services/filebinary.ts:21

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

Inherited from​

CloudBinaryParameters.expose

Source​

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


folder​

folder: string

Define the folder to store objects in

Source​

packages/core/src/services/filebinary.ts:14


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[]

Inherited from​

CloudBinaryParameters.map

Source​

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


maxSize?​

maxSize?: number

Maximum size to handle

Default​

10Mb

Source​

packages/core/src/services/filebinary.ts:19


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[]

Inherited from​

CloudBinaryParameters.models

Source​

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


openapi?​

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore​

Inherited from​

CloudBinaryParameters.openapi

Source​

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


prefix?​

prefix?: string

Inherited from​

CloudBinaryParameters.prefix

Source​

packages/core/src/services/cloudbinary.ts:9


type​

type: string

Type of the service

Inherited from​

CloudBinaryParameters.type

Source​

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


url?​

url?: string

URL on which to serve the content

Inherited from​

CloudBinaryParameters.url

Source​

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