Inherited from CloudWatchLogger.constructor

Parameters
- webda: Core
  
  The main instance of Webda
- name: string
  
  The name of the service
- Default value params: any = {}
  
  The parameters block define in the configuration file
Returns FileBinary
- Defined in packages/core/src/services/service.ts:59

Properties

_createException: string

_initException: any = undefined

_initTime: number

_lowercaseMaps: any

_name: string

Service name

_webda: Core

Webda Core object

logger: Logger

Logger with class context

parameters: T

Hold the parameters for your service

It will be bring from the webda.config.json

defaultMaxListeners: number

Methods

___cleanData(): Promise<void>

Overrides Service.___cleanData

Returns Promise<void>
- Defined in packages/core/src/services/filebinary.ts:251

__clean(): Promise<any>

Inherited from CloudWatchLogger.__clean

Clean the service data, can only be used in test mode

abstract

Returns Promise<any>
- Defined in packages/core/src/services/service.ts:229

_checkMap(name: any, property: any): void

Inherited from S3Binary._checkMap

Parameters
- name: any
- property: any
Returns void
- Defined in packages/core/src/services/binary.ts:286

_cleanHash(hash: any): void

Parameters
- hash: any
Returns void
- Defined in packages/core/src/services/filebinary.ts:179

_cleanUsage(hash: any, uuid: any): void

Parameters
- hash: any
- uuid: any
Returns void
- Defined in packages/core/src/services/filebinary.ts:181

_get(info: any): ReadableStream<any>

Overrides Binary._get

Parameters
- info: any
Returns ReadableStream<any>
- Defined in packages/core/src/services/filebinary.ts:78

_getFile(req: any): any

Inherited from S3Binary._getFile

Parameters
- req: any
Returns any
- Defined in packages/core/src/services/binary.ts:379

_getHashes(buffer: any): any

Inherited from S3Binary._getHashes

Parameters
- buffer: any
Returns any
- Defined in packages/core/src/services/binary.ts:266

_getPath(hash: any, postfix?: any): string

Parameters
- hash: any
- Default value postfix: any = undefined
Returns string
- Defined in packages/core/src/services/filebinary.ts:87

_getUrl(info: any, ctx: Context): void

Inherited from Binary._getUrl

Parameters
- info: any
- ctx: Context
Returns void
- Defined in packages/core/src/services/binary.ts:217

_initRoutes(): boolean

Overrides Binary._initRoutes

Returns boolean
- Defined in packages/core/src/services/filebinary.ts:54

_prepareInput(file: any): void

Inherited from S3Binary._prepareInput

Parameters
- file: any
Returns void
- Defined in packages/core/src/services/binary.ts:277

_store(file: any, targetStore: any, object: any): void

Parameters
- file: any
- targetStore: any
- object: any
Returns void
- Defined in packages/core/src/services/filebinary.ts:217

_touch(path: any): void

Parameters
- path: any
Returns void
- Defined in packages/core/src/services/filebinary.ts:94

_validChallenge(challenge: any): boolean

Inherited from S3Binary._validChallenge

Parameters
- challenge: any
Returns boolean
- Defined in packages/core/src/services/binary.ts:299

_verifyMapAndStore(ctx: Context): Store<CoreModel>

Inherited from S3Binary._verifyMapAndStore

Parameters
- ctx: Context
Returns Store<CoreModel>
- Defined in packages/core/src/services/binary.ts:503

addListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.addListener

Overrides EventEmitter.addListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:32
Returns this
- Defined in node_modules/@types/node/events.d.ts:32

addRoute(url: string, methods: HttpMethodType[], executer: Function, openapi?: object, allowPath?: boolean): void

Inherited from CloudWatchLogger.addRoute

Add a route dynamicaly

Parameters
- url: string
  
  of the route can contains dynamic part like {uuid}
- methods: HttpMethodType[]
- executer: Function
  
  Method to execute for this route
- Default value openapi: object = {}
- Default value allowPath: boolean = false
Returns void
- Defined in packages/core/src/services/service.ts:121

cascadeDelete(info: any, uuid: any): void

Overrides Binary.cascadeDelete

Parameters
- info: any
- uuid: any
Returns void
- Defined in packages/core/src/services/filebinary.ts:213

challenge(hash: any, challenge: any): boolean

Overrides S3Binary.challenge

Parameters
- hash: any
- challenge: any
Returns boolean
- Defined in packages/core/src/services/filebinary.ts:202

computeParameters(): void

Overrides CloudWatchLogger.computeParameters

Create the storage folder if needed

Returns void
- Defined in packages/core/src/services/filebinary.ts:47

delete(targetStore: any, object: any, property: any, index: any): any

Overrides Binary.delete

Parameters
- targetStore: any
- object: any
- property: any
- index: any
Returns any
- Defined in packages/core/src/services/filebinary.ts:194

deleteSuccess(targetStore: any, object: any, property: any, index: any): any

Inherited from S3Binary.deleteSuccess

Parameters
- targetStore: any
- object: any
- property: any
- index: any
Returns any
- Defined in packages/core/src/services/binary.ts:362

downloadTo(info: any, filename: any): Promise<void>

Inherited from S3Binary.downloadTo

Download a binary to a file

Parameters
- info: any
  
  The reference stored in your target object
- filename: any
Returns Promise<void>
- Defined in packages/core/src/services/binary.ts:193

emit(event: string | symbol, ...args: any[]): boolean

Inherited from CloudWatchLogger.emit

Overrides EventEmitter.emit

Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
- Defined in node_modules/@types/node/events.d.ts:44

emitSync(event: any, data: any): Promise<any[]>

Inherited from CloudWatchLogger.emitSync

Emit the event with data and wait for Promise to finish if listener returned a Promise

Parameters
- event: any
- data: any
Returns Promise<any[]>
- Defined in packages/core/src/services/service.ts:180

eventNames(): Array<string | symbol>

Inherited from CloudWatchLogger.eventNames

Overrides EventEmitter.eventNames

Returns Array<string | symbol>
- Defined in node_modules/@types/node/events.d.ts:45

get(info: any): Promise<ReadableStream<any>>

Inherited from S3Binary.get

Get a binary

emits

'binaryGet'

Parameters
- info: any
  
  The reference stored in your target object
Returns Promise<ReadableStream<any>>
- Defined in packages/core/src/services/binary.ts:179

getMaxListeners(): number

Inherited from CloudWatchLogger.getMaxListeners

Overrides EventEmitter.getMaxListeners

Returns number
- Defined in node_modules/@types/node/events.d.ts:41

getName(): string

Inherited from CloudWatchLogger.getName

Get service name

Returns string
- Defined in packages/core/src/services/service.ts:220

getParameters(): T

Inherited from CloudWatchLogger.getParameters

Get the service parameters

Returns T
- Defined in packages/core/src/services/service.ts:92

getPutUrl(ctx: Context): string

Parameters
- ctx: Context
Returns string
- Defined in packages/core/src/services/filebinary.ts:100

getService<T>(service: string): T

Inherited from CloudWatchLogger.getService

Return a webda service

Type parameters
- T: Service<ServiceParameters>
Parameters
- service: string
  
  name to retrieve
Returns T
- Defined in packages/core/src/services/service.ts:207

getUsageCount(hash: any): Promise<number>

Overrides Binary.getUsageCount

Parameters
- hash: any
Returns Promise<number>
- Defined in packages/core/src/services/filebinary.ts:170

getWebda(): Core

Inherited from CloudWatchLogger.getWebda

Return WebdaCore

Returns Core
- Defined in packages/core/src/services/service.ts:99

httpChallenge(ctx: Context): Promise<void>

Inherited from S3Binary.httpChallenge

Parameters
- ctx: Context
Returns Promise<void>
- Defined in packages/core/src/services/binary.ts:531

httpPost(ctx: Context): Promise<void>

Inherited from S3Binary.httpPost

Parameters
- ctx: Context
Returns Promise<void>
- Defined in packages/core/src/services/binary.ts:496

httpRoute(ctx: Context): Promise<void>

Inherited from S3Binary.httpRoute

Parameters
- ctx: Context
Returns Promise<void>
- Defined in packages/core/src/services/binary.ts:542

initMap(map: any): void

Inherited from S3Binary.initMap

Parameters
- map: any
Returns void
- Defined in packages/core/src/services/binary.ts:225

initModel(obj: any): BinaryMap

Inherited from S3Binary.initModel

Parameters
- obj: any
Returns BinaryMap
- Defined in packages/core/src/services/binary.ts:262

initRoutes(): void

Inherited from S3Binary.initRoutes

Overrides CloudWatchLogger.initRoutes

Init the Binary system routes

Returns void
- Defined in packages/core/src/services/binary.ts:396

listenerCount(type: string | symbol): number

Inherited from CloudWatchLogger.listenerCount

Overrides EventEmitter.listenerCount

Parameters
- type: string | symbol
Returns number
- Defined in node_modules/@types/node/events.d.ts:46

listeners(event: string | symbol): Function[]

Inherited from CloudWatchLogger.listeners

Overrides EventEmitter.listeners

Parameters
- event: string | symbol
Returns Function[]
- Defined in node_modules/@types/node/events.d.ts:42

loadParameters(params: any): ServiceParameters

Overrides Binary.loadParameters

Load parameters

Parameters
- params: any
Returns ServiceParameters
- Defined in packages/core/src/services/filebinary.ts:40

log(level: WorkerLogLevel, ...args: any[]): void

Inherited from CloudWatchLogger.log

Parameters
- level: WorkerLogLevel
  
  to log
- Rest ...args: any[]
Returns void
- Defined in packages/core/src/services/service.ts:249

off(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.off

Overrides EventEmitter.off

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:38
Returns this
- Defined in node_modules/@types/node/events.d.ts:38

on(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.on

Overrides EventEmitter.on

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:33
Returns this
- Defined in node_modules/@types/node/events.d.ts:33

onAsync(event: any, callback: any, queue?: string): void

Inherited from CloudWatchLogger.onAsync

Listen to an event as on(...) would do except that it will be asynchronous

Parameters
- event: any
- callback: any
- Default value queue: string = undefined
  
  Name of queue to use, can be undefined, queue name are used to define differents priorities
Returns void
- Defined in packages/core/src/services/service.ts:199

once(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.once

Overrides EventEmitter.once

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:34
Returns this
- Defined in node_modules/@types/node/events.d.ts:34

prependListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.prependListener

Overrides EventEmitter.prependListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:35
Returns this
- Defined in node_modules/@types/node/events.d.ts:35

prependOnceListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.prependOnceListener

Overrides EventEmitter.prependOnceListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:36
Returns this
- Defined in node_modules/@types/node/events.d.ts:36

rawListeners(event: string | symbol): Function[]

Inherited from CloudWatchLogger.rawListeners

Overrides EventEmitter.rawListeners

Parameters
- event: string | symbol
Returns Function[]
- Defined in node_modules/@types/node/events.d.ts:43

reinit(config: any): Promise<void>

Inherited from CloudWatchLogger.reinit

Parameters
- config: any
  
  new parameters for the service
Returns Promise<void>
- Defined in packages/core/src/services/service.ts:171

removeAllListeners(event?: string | symbol): this

Inherited from CloudWatchLogger.removeAllListeners

Overrides EventEmitter.removeAllListeners

Parameters
- Optional event: string | symbol
Returns this
- Defined in node_modules/@types/node/events.d.ts:39

removeListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.removeListener

Overrides EventEmitter.removeListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:37
Returns this
- Defined in node_modules/@types/node/events.d.ts:37

resolve(): void

Inherited from CloudWatchLogger.resolve

Resolve parameters Call initRoutes and initBeanRoutes

Returns void
- Defined in packages/core/src/services/service.ts:107

setMaxListeners(n: number): this

Inherited from CloudWatchLogger.setMaxListeners

Overrides EventEmitter.setMaxListeners

Parameters
- n: number
Returns this
- Defined in node_modules/@types/node/events.d.ts:40

store(targetStore: any, object: any, property: any, file: any, metadatas: any, index?: string): Promise<any>

Overrides Binary.store

Parameters
- targetStore: any
- object: any
- property: any
- file: any
- metadatas: any
- Default value index: string = "add"
Returns Promise<any>
- Defined in packages/core/src/services/filebinary.ts:227

toPublicJSON(object: any): string

Inherited from CloudWatchLogger.toPublicJSON

Convert an object to JSON using the Webda json filter

Parameters
- object: any
  
  The object to export
Returns string

The export of the strip object ( removed all attribute with _ )
- Defined in packages/core/src/services/service.ts:155

update(targetStore: any, object: any, property: any, index: any, file: any, metadatas: any): Promise<any>

Overrides Binary.update

Parameters
- targetStore: any
- object: any
- property: any
- index: any
- file: any
- metadatas: any
Returns Promise<any>
- Defined in packages/core/src/services/filebinary.ts:239

updateSuccess(targetStore: any, object: any, property: any, index: any, file: any, metadatas: any): Promise<any>

Inherited from S3Binary.updateSuccess

Parameters
- targetStore: any
- object: any
- property: any
- index: any
- file: any
- metadatas: any
Returns Promise<any>
- Defined in packages/core/src/services/binary.ts:308

getModda(): ModdaDefinition

Overrides Queue.getModda

Returns ModdaDefinition
- Defined in packages/core/src/services/filebinary.ts:264

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from CloudWatchLogger.listenerCount

deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
- Defined in node_modules/@types/node/events.d.ts:29

Generated using TypeDoc

Class FileBinary<T>

Type parameters

T: FileBinaryParameters

Hierarchy

Constructors

Properties

Methods

Constructors

Parameters

webda: Core

name: string

Default value params: any = {}

Returns FileBinary

Properties

Methods

Returns Promise<void>

Returns Promise<any>

Parameters

name: any

property: any

Returns void

Parameters

hash: any

Returns void

Parameters

hash: any

uuid: any

Returns void

Parameters

info: any

Returns ReadableStream<any>

Parameters

req: any

Returns any

Parameters

buffer: any

Returns any

Parameters

hash: any

Default value postfix: any = undefined

Returns string

Parameters

info: any

ctx: Context

Returns void

Returns boolean

Parameters

file: any

Returns void

Parameters

file: any

targetStore: any

object: any

Returns void

Parameters

path: any

Returns void

Parameters

challenge: any

Returns boolean

Parameters

ctx: Context

Returns Store<CoreModel>

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

Parameters

url: string

methods: HttpMethodType[]

executer: Function

Default value openapi: object = {}

Default value allowPath: boolean = false

Returns void

Parameters

info: any

uuid: any