@webda/core • Readme | API

Class: FileBinary<T>

FileBinary handles the storage of binary on a hard drive

The structure used for now is /folder/{hash}/data /folder/{hash}/{targetStore}_{uuid} /folder/{hash}/challenge

It takes one parameter folder: "path"

See Binary the general interface

Webda Modda

Extends

CloudBinary<T>

Type parameters

• T extends FileBinaryParameters = FileBinaryParameters

Constructors

new FileBinary(webda, name, params)

new FileBinary<T>(webda, name, params): FileBinary<T>

Parameters

• webda: Core<CoreEvents>

The main instance of Webda

• name: string

The name of the service

• params: DeepPartial<T>= {}

The parameters block define in the configuration file

Properties

_createException

_createException: string

Inherited from

CloudBinary._createException

Source

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

_initException

_initException: any = undefined

Inherited from

CloudBinary._initException

Source

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

_initTime

_initTime: number

Inherited from

CloudBinary._initTime

Source

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

_lowercaseMaps

_lowercaseMaps: any

Inherited from

CloudBinary._lowercaseMaps

Source

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

_name

protected _name: string

Service name

Inherited from

CloudBinary._name

Source

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

_webda

protected _webda: Core<CoreEvents>

Webda Core object

Inherited from

CloudBinary._webda

Source

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

cryptoService

cryptoService: CryptoService<CryptoServiceParameters>

Used for hmac

Source

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

logger

protected logger: Logger

Logger with class context

Inherited from

CloudBinary.logger

Source

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

metrics

metrics: Object

Get metrics

Type declaration

delete

delete: Counter<string>

download

download: Counter<string>

metadataUpdate

metadataUpdate: Counter<string>

upload

upload: Counter<string>

Inherited from

CloudBinary.metrics

Source

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

parameters

protected parameters: T

Hold the parameters for your service

It will be bring from the webda.config.json

Inherited from

CloudBinary.parameters

Source

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

captureRejectionSymbol

static readonly captureRejectionSymbol: typeof captureRejectionSymbol

Inherited from

CloudBinary.captureRejectionSymbol

Source

packages/core/node_modules/@types/node/events.d.ts:328

captureRejections

static captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Inherited from

CloudBinary.captureRejections

Source

packages/core/node_modules/@types/node/events.d.ts:333

defaultMaxListeners

static defaultMaxListeners: number

Inherited from

CloudBinary.defaultMaxListeners

Source

packages/core/node_modules/@types/node/events.d.ts:334

errorMonitor

static readonly errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Inherited from

CloudBinary.errorMonitor

Source

packages/core/node_modules/@types/node/events.d.ts:327

Methods

___cleanData()

___cleanData(): Promise<void>

Clean all data

Returns

Promise<void>

Overrides

CloudBinary.___cleanData

Source

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

__clean()

__clean(): Promise<void>

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

Returns

Promise<void>

Inherited from

CloudBinary.__clean

Abstract

Source

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

_cleanHash()

_cleanHash(hash): Promise<void>

Delete any usage marker and hash

Parameters

• hash: string

to remove

Returns

Promise<void>

Source

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

_cleanUsage()

_cleanUsage(hash, uuid, attribute?): Promise<void>

Parameters

• hash: string

• uuid: string

• attribute?: string

Returns

Promise<void>

Overrides

CloudBinary._cleanUsage

Source

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

_get()

_get(info): Promise<Readable>

Parameters

• info: BinaryMap<any>

Returns

Promise<Readable>

Overrides

CloudBinary._get

Inherit Doc

Source

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

_getFile()

_getFile(req): Promise<BinaryFile<any>>

Get file either from multipart post or raw

Parameters

• req: WebContext<any, any>

Returns

Promise<BinaryFile<any>>

Inherited from

CloudBinary._getFile

Source

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

_getKey()

_getKey(hash, suffix): string

Return the S3 key

Parameters

• hash: string

• suffix: string= "data"

Returns

string

Inherited from

CloudBinary._getKey

Source

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

_getPath()

_getPath(hash, postfix): string

Get storage path for a hash

Parameters

• hash: string

• postfix: string= undefined

Returns

string

Source

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

_initRoutes()

_initRoutes(): void

Init the Binary system routes

Making sure parameters.expose exists prior

Returns

void

Inherited from

CloudBinary._initRoutes

Source

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

_store()

_store(file, object, attribute): Promise<void>

Parameters

• file: BinaryFile<any>

• object: CoreModel

• attribute: string

Returns

Promise<void>

Source

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

_touch()

_touch(filePath, mode): void

Parameters

• filePath: any

• mode: number= 0o600

Returns

void

Source

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

_verifyMapAndStore()

_verifyMapAndStore(ctx): Store<CoreModel, StoreParameters, StoreEvents>

Based on the request parameter verify it match a known mapping

Parameters

• ctx: WebContext<any, any>

Returns

Store<CoreModel, StoreParameters, StoreEvents>

Inherited from

CloudBinary._verifyMapAndStore

Source

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

addListener()

addListener(eventName, listener): this

Alias for emitter.on(eventName, listener).

Parameters

• eventName: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

CloudBinary.addListener

Since

v0.1.26

Source

packages/core/node_modules/@types/node/events.d.ts:354

addRoute()

protected addRoute(url, methods, executer, openapi, override): void

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

• openapi: OpenAPIWebdaDefinition= {}

• override: boolean= false

Returns

void

Inherited from

CloudBinary.addRoute

Source

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

authorizeClientEvent()

authorizeClientEvent(_event, _context): boolean

Authorize a public event subscription

Parameters

• _event: string

• _context: OperationContext<any, any>

Returns

boolean

Inherited from

CloudBinary.authorizeClientEvent

Source

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

cascadeDelete()

cascadeDelete(info, uuid): Promise<void>

Cascade delete the object

Parameters

• info: BinaryMap<any>

of the map

• uuid: string

of the object

Returns

Promise<void>

Overrides

CloudBinary.cascadeDelete

Source

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

challenge()

challenge(hash, challenge): boolean

Parameters

• hash: any

• challenge: any

Returns

boolean

Source

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

checkMap()

protected checkMap(object, property): void

Check if a map is defined

Parameters

• object: CoreModel

• property: string

Returns

void

Inherited from

CloudBinary.checkMap

Source

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

computeParameters()

computeParameters(): void

Create the storage folder if needed

Returns

void

Overrides

CloudBinary.computeParameters

Source

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

delete()

delete(object, property, index?): Promise<void>

Delete a binary

Parameters

• object: CoreModel

The object uuid to get from the store

• property: string

The object property to add the file to

• index?: number

The index of the file to change in the property

Returns

Promise<void>

Overrides

CloudBinary.delete

Emits

'binaryDelete'

Source

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

deleteSuccess()

deleteSuccess(object, property, index?): Promise<any>

Parameters

• object: BinaryModel<Object>

• property: string

• index?: number

Returns

Promise<any>

Inherited from

CloudBinary.deleteSuccess

Source

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

downloadBinaryLink()

downloadBinaryLink(ctx): Promise<void>

Download a binary with a challenge

Parameters

• ctx: WebContext<any, any>

Returns

Promise<void>

Source

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

downloadTo()

downloadTo(info, filename): Promise<void>

Download a binary to a file

Parameters

• info: BinaryMap<any>

The reference stored in your target object

• filename: any

Returns

Promise<void>

Inherited from

CloudBinary.downloadTo

Source

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

emit()

emit<Key>(event, data): boolean

Override to allow capturing long listeners

Type parameters

• Key extends keyof BinaryEvents

Parameters

• event: symbol | Key

• data: BinaryEvents[Key]

Returns

boolean

Inherited from

CloudBinary.emit

Source

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

emitSync()

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

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

Type parameters

• Key extends keyof BinaryEvents

Parameters

• event: Key

• data: BinaryEvents[Key]

Returns

Promise<any[]>

Inherited from

CloudBinary.emitSync

Source

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

eventNames()

eventNames(): (string | symbol)[]

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

const EventEmitter = require('events');
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Returns

(string | symbol)[]

Inherited from

CloudBinary.eventNames

Since

v6.0.0

Source

packages/core/node_modules/@types/node/events.d.ts:669

get()

get(info): Promise<Readable>

Get a binary

Parameters

• info: BinaryMap<any>

The reference stored in your target object

Returns

Promise<Readable>

Inherited from

CloudBinary.get

Emits

'binaryGet'

Source

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

getClientEvents()

getClientEvents(): string[]

Return the events that an external system can subscribe to

Returns

string[]

Inherited from

CloudBinary.getClientEvents

Source

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

getMaxListeners()

getMaxListeners(): number

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

Returns

number

Inherited from

CloudBinary.getMaxListeners

Since

v1.0.0

Source

packages/core/node_modules/@types/node/events.d.ts:526

getMetric()

getMetric<T>(type, configuration): T

Add service name label

Type parameters

• T = Counter<string> | Histogram<string> | Gauge<string>

Parameters

• type: Constructor<T, [MetricConfiguration<T>]>

• configuration: MetricConfiguration<T>

Returns

T

Inherited from

CloudBinary.getMetric

Source

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

getName()

getName(): string

Get service name

Returns

string

Inherited from

CloudBinary.getName

Source

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

getOpenApiReplacements()

getOpenApiReplacements(): any

Return variables for replacement in openapi

Returns

any

Inherited from

CloudBinary.getOpenApiReplacements

Source

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

getOperationId()

getOperationId(id): string

If undefined is returned it cancel the operation registration

Parameters

• id: string

Returns

string

Inherited from

CloudBinary.getOperationId

Source

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

getOperationName()

protected getOperationName(): string

Return the name of the service for OpenAPI

Returns

string

Inherited from

CloudBinary.getOperationName

Source

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

getParameters()

getParameters(): T

Get the service parameters

Returns

T

Inherited from

CloudBinary.getParameters

Source

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

getPutUrl()

getPutUrl(ctx): Promise<string>

Get put URL

Parameters

• ctx: WebContext<BinaryFile<any>, any>

Returns

Promise<string>

Source

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

getRedirectUrlFromObject()

getRedirectUrlFromObject(binaryMap, context, expires): Promise<string>

Get a UrlFromObject

Parameters

• binaryMap: any

• context: any

• expires: number= 30

Returns

Promise<string>

Inherited from

CloudBinary.getRedirectUrlFromObject

Source

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

getService()

getService<K>(service): K

Return a webda service

Type parameters

• K extends Service<ServiceParameters, Events>

Parameters

• service: string

name to retrieve

Returns

K

Inherited from

CloudBinary.getService

Source

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

getSignedUrlFromMap()

getSignedUrlFromMap(map, expires, context): Promise<string>

Get signed url to download an element

Parameters

• map: BinaryMap<any>

• expires: number

• context: WebContext<any, any>

Returns

Promise<string>

Overrides

CloudBinary.getSignedUrlFromMap

Source

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

getToken()

getToken(hash, method, expiresIn): Promise<string>

Get token for action

Parameters

• hash: string

• method: "GET" | "PUT"

• expiresIn: number= 60

Returns

Promise<string>

Source

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

getUrl()

getUrl(url, _methods): string

Return the full path url based on parameters

Parameters

• url: string

relative url to service

• _methods: HttpMethodType[]

in case we need filtering (like Store)

Returns

string

absolute url or undefined if need to skip the Route

Inherited from

CloudBinary.getUrl

Source

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

getUsageCount()

getUsageCount(hash): Promise<number>

The store can retrieve how many time a binary has been used

Parameters

• hash: string

Returns

Promise<number>

Overrides

CloudBinary.getUsageCount

Source

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

getWebda()

getWebda(): Core<CoreEvents>

Return WebdaCore

Returns

Core<CoreEvents>

Inherited from

CloudBinary.getWebda

Source

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

handleBinary()

handleBinary(modelName, attribute): 0 | 2 | 1 | -1

Define if binary is managed by the store

Parameters

• modelName: string

• attribute: string

Returns

0 | 2 | 1 | -1

-1 if not managed, 0 if managed but by default, 1 if managed and in the map, 2 if explicit with attribute and model

Inherited from

CloudBinary.handleBinary

Source

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

httpChallenge()

httpChallenge(ctx): Promise<void>

Mechanism to add a data based on challenge

Parameters

• ctx: WebContext<BinaryFile<any>, any>

Returns

Promise<void>

Inherited from

CloudBinary.httpChallenge

Source

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

httpGet()

httpGet(context): Promise<void>

Redirect to the temporary link to S3 object or return it if returnInfo=true

Parameters

• context: WebContext<any, any>

Returns

Promise<void>

Inherited from

CloudBinary.httpGet

Source

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

httpRoute()

httpRoute(ctx): Promise<void>

Manage the different routes

Parameters

• ctx: WebContext<any, any>

Returns

Promise<void>

Inherited from

CloudBinary.httpRoute

Source

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

init()

init(): Promise<FileBinary<T>>

Will be called after all the Services are created

Returns

Promise<FileBinary<T>>

Inherited from

CloudBinary.init

Abstract

Source

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

initMap()

initMap(map): void

Init the declared maps, adding reverse maps

Parameters

• map: any

Returns

void

Inherited from

CloudBinary.initMap

Source

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

initMetrics()

initMetrics(): void

Returns

void

Inherited from

CloudBinary.initMetrics

Source

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

initOperations()

initOperations(): void

Init the operations

Returns

void

Inherited from

CloudBinary.initOperations

Source

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

initRoutes()

initRoutes(): void

Returns

void

Overrides

CloudBinary.initRoutes

Source

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

listenerCount()

listenerCount(eventName): number

Returns the number of listeners listening to the event named eventName.

Parameters

• eventName: string | symbol

The name of the event being listened for

Returns

number

Inherited from

CloudBinary.listenerCount

Since

v3.2.0

Source

packages/core/node_modules/@types/node/events.d.ts:616

listeners()

listeners(eventName): Function[]

Returns a copy of the array of listeners for the event named eventName.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Parameters

• eventName: string | symbol

Returns

Function[]

Inherited from

CloudBinary.listeners

Since

v0.1.26

Source

packages/core/node_modules/@types/node/events.d.ts:539

loadParameters()

loadParameters(params): CloudBinaryParameters

Load parameters

Parameters

• params: any

Returns

CloudBinaryParameters

Overrides

CloudBinary.loadParameters

Source

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

log()

log(level, ...args): void

Parameters

• level: WorkerLogLevel

to log

• ...args: any[]

Returns

void

Inherited from

CloudBinary.log

Source

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

newModel()

newModel(obj): BinaryMap<any>

Based on the raw Map init a BinaryMap

Parameters

• obj: any

Returns

BinaryMap<any>

Inherited from

CloudBinary.newModel

Source

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

off()

off(eventName, listener): this

Alias for emitter.removeListener().

Parameters

• eventName: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

CloudBinary.off

Since

v10.0.0

Source

packages/core/node_modules/@types/node/events.d.ts:499

on()

on<Key>(event, listener): this

Type the listener part

Type parameters

• Key extends keyof BinaryEvents

Parameters

• event: symbol | Key

• listener: (evt) => void

Returns

this

Inherited from

CloudBinary.on

Source

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

onAsync()

onAsync<Key>(event, listener, queue): void

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

Type parameters

• Key extends keyof BinaryEvents

Parameters

• event: Key

• listener: (evt) => void

• queue: string= undefined

Name of queue to use, can be undefined, queue name are used to define differents priorities

Returns

void

Inherited from

CloudBinary.onAsync

Source

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

once()

once(eventName, listener): this

Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Parameters

• eventName: string | symbol

The name of the event.

• listener: (...args) => void

The callback function

Returns

this

Inherited from

CloudBinary.once

Since

v0.3.0

Source

packages/core/node_modules/@types/node/events.d.ts:414

prependListener()

prependListener(eventName, listener): this

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

• eventName: string | symbol

The name of the event.

• listener: (...args) => void

The callback function

Returns

this

Inherited from

CloudBinary.prependListener

Since

v6.0.0

Source

packages/core/node_modules/@types/node/events.d.ts:634

prependOnceListener()

prependOnceListener(eventName, listener): this

Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

• eventName: string | symbol

The name of the event.

• listener: (...args) => void

The callback function

Returns

this

Inherited from

CloudBinary.prependOnceListener

Since

v6.0.0

Source

packages/core/node_modules/@types/node/events.d.ts:650

rawListeners()

rawListeners(eventName): Function[]

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Parameters

• eventName: string | symbol

Returns

Function[]

Inherited from

CloudBinary.rawListeners

Since

v9.4.0

Source

packages/core/node_modules/@types/node/events.d.ts:569

reinit()

reinit(config): Promise<FileBinary<T>>

Parameters

• config: DeepPartial<T>

new parameters for the service

Returns

Promise<FileBinary<T>>

Inherited from

CloudBinary.reinit

Source

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

removeAllListeners()

removeAllListeners(event?): this

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

• event?: string | symbol

Returns

this

Inherited from

CloudBinary.removeAllListeners

Since

v0.1.26

Source

packages/core/node_modules/@types/node/events.d.ts:510

removeListener()

removeListener(eventName, listener): this

Removes the specified listener from the listener array for the event namedeventName.

const callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

const myEmitter = new MyEmitter();

const callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping')listener is removed:

const ee = new EventEmitter();

function pong() {
  console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

• eventName: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

CloudBinary.removeListener

Since

v0.1.26

Source

packages/core/node_modules/@types/node/events.d.ts:494

resolve()

resolve(): this

Returns

this

Inherited from

CloudBinary.resolve

Source

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

setMaxListeners()

setMaxListeners(n): this

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

• n: number

Returns

this

Inherited from

CloudBinary.setMaxListeners

Since

v0.3.5

Source

packages/core/node_modules/@types/node/events.d.ts:520

stop()

stop(): Promise<void>

Shutdown the current service if action need to be taken

Returns

Promise<void>

Inherited from

CloudBinary.stop

Source

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

store()

store(object, property, file): Promise<any>

When you store a binary to be able to retrieve it you need to store the information into another object

If you have a User object define like this : User = {'name': 'Remi', 'uuid': 'Loopingz'} You will call the store(userStore, 'Loopingz', 'images', filedata, {'type':'profile'}) After a successful call the object will look like

User = {
 'name': 'Remi',
 'uuid': 'Loopingz',
 'images': [
   {'type':'profile','hash':'a12545...','size':1245,'mime':'application/octet'}
  ]
}

Parameters

• object: CoreModel

The object uuid to get from the store

• property: string

The object property to add the file to

• file: BinaryFile<any>

The file by itself

Returns

Promise<any>

Overrides

CloudBinary.store

Emits

'binaryCreate'

Source

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

toJSON()

toJSON(): string

Prevent service to be serialized

Returns

string

Inherited from

CloudBinary.toJSON

Source

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

toPublicJSON()

toPublicJSON(object): string

Convert an object to JSON using the Webda json filter

Parameters

• object: unknown

The object to export

Returns

string

The export of the strip object ( removed all attribute with _ )

Inherited from

CloudBinary.toPublicJSON

Source

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

toString()

toString(): string

Return service representation

Returns

string

Inherited from

CloudBinary.toString

Source

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

uploadSuccess()

uploadSuccess(object, property, file): Promise<void>

Ensure events are sent correctly after an upload and update the BinaryFileInfo in targetted object

Parameters

• object: BinaryModel<Object>

• property: string

• file: BinaryFileInfo

Returns

Promise<void>

Inherited from

CloudBinary.uploadSuccess

Source

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

getEventListeners()

static getEventListeners(emitter, name): Function[]

Returns a copy of the array of listeners for the event named eventName.

For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

const { getEventListeners, EventEmitter } = require('events');

{
  const ee = new EventEmitter();
  const listener = () => console.log('Events are fun');
  ee.on('foo', listener);
  getEventListeners(ee, 'foo'); // [listener]
}
{
  const et = new EventTarget();
  const listener = () => console.log('Events are fun');
  et.addEventListener('foo', listener);
  getEventListeners(et, 'foo'); // [listener]
}

Parameters

• emitter: EventEmitter | _DOMEventTarget

• name: string | symbol

Returns

Function[]

Inherited from

CloudBinary.getEventListeners

Since

v15.2.0, v14.17.0

Source

packages/core/node_modules/@types/node/events.d.ts:299

listenerCount()

static listenerCount(emitter, eventName): number

A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

const { EventEmitter, listenerCount } = require('events');
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2

Parameters

• emitter: EventEmitter

The emitter to query

• eventName: string | symbol

The event name

Returns

number

Inherited from

CloudBinary.listenerCount

Since

v0.9.12

Deprecated

Since v3.2.0 - Use listenerCount instead.

Source

packages/core/node_modules/@types/node/events.d.ts:271

on()

static on(emitter, eventName, options?): AsyncIterableIterator<any>

const { on, EventEmitter } = require('events');

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo')) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

An AbortSignal can be used to cancel waiting on events:

const { on, EventEmitter } = require('events');
const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

process.nextTick(() => ac.abort());

Parameters

• emitter: EventEmitter

• eventName: string

The name of the event being listened for

• options?: StaticEventEmitterOptions

Returns

AsyncIterableIterator<any>

that iterates eventName events emitted by the emitter

Inherited from

CloudBinary.on

Since

v13.6.0, v12.16.0

Source

packages/core/node_modules/@types/node/events.d.ts:254

once()

once(emitter, eventName, options)

static once(emitter, eventName, options?): Promise<any[]>

Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

const { once, EventEmitter } = require('events');

async function run() {
  const ee = new EventEmitter();

  process.nextTick(() => {
    ee.emit('myevent', 42);
  });

  const [value] = await once(ee, 'myevent');
  console.log(value);

  const err = new Error('kaboom');
  process.nextTick(() => {
    ee.emit('error', err);
  });

  try {
    await once(ee, 'myevent');
  } catch (err) {
    console.log('error happened', err);
  }
}

run();

The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.log('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Parameters

• emitter: _NodeEventTarget

• eventName: string | symbol

• options?: StaticEventEmitterOptions

Returns

Promise<any[]>

Inherited from

CloudBinary.once

Since

v11.13.0, v10.16.0

Source

packages/core/node_modules/@types/node/events.d.ts:194

once(emitter, eventName, options)

static once(emitter, eventName, options?): Promise<any[]>

Parameters

• emitter: _DOMEventTarget

• eventName: string

• options?: StaticEventEmitterOptions

Returns

Promise<any[]>

Inherited from

CloudBinary.once

Source

packages/core/node_modules/@types/node/events.d.ts:195

setMaxListeners()

static setMaxListeners(n?, ...eventTargets?): void

const {
  setMaxListeners,
  EventEmitter
} = require('events');

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

Parameters

• n?: number

A non-negative number. The maximum number of listeners per EventTarget event.

• ...eventTargets?: (EventEmitter | _DOMEventTarget)[]

Returns

void

Inherited from

CloudBinary.setMaxListeners

Since

v15.4.0

Source

packages/core/node_modules/@types/node/events.d.ts:317

streamToBuffer()

static streamToBuffer(stream): Promise<Buffer>

Read a stream to a buffer

Parameters

• stream: Readable

Returns

Promise<Buffer>

Inherited from

CloudBinary.streamToBuffer

Source

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

Class: FileBinary<T>

Webda Modda​

Extends​

Type parameters​

Constructors​

new FileBinary(webda, name, params)​

Parameters​

Returns​

Inherited from​

Source​

Properties​

_createException​

Inherited from​

Source​

_initException​

Inherited from​

Source​

_initTime​

Inherited from​

Source​

_lowercaseMaps​

Inherited from​

Source​

_name​

Inherited from​

Source​

_webda​

Inherited from​

Source​

cryptoService​

Source​

logger​

Inherited from​

Source​

metrics​

Type declaration​

delete​

download​

metadataUpdate​

upload​

Inherited from​

Source​

parameters​

Inherited from​

Source​

captureRejectionSymbol​

Inherited from​

Source​

captureRejections​

Inherited from​

Source​

defaultMaxListeners​

Inherited from​

Source​

errorMonitor​

Inherited from​

Source​

Methods​

___cleanData()​

Returns​

Overrides​

Source​

__clean()​

Returns​

Inherited from​

Abstract​

Source​

_cleanHash()​

Parameters​

Returns​

Source​

_cleanUsage()​

Parameters​

Returns​

Overrides​

Source​

_get()​

Parameters​

Returns​

Overrides​

Webda Modda

Extends

Type parameters

Constructors

new FileBinary(webda, name, params)

Parameters

Returns

Inherited from

Source

Properties

_createException

Inherited from

Source

_initException

Inherited from

Source

_initTime

Inherited from

Source

_lowercaseMaps

Inherited from

Source

_name

Inherited from

Source

_webda

Inherited from

Source

cryptoService

Source

logger

Inherited from

Source

metrics

Type declaration

delete

download

metadataUpdate

upload

Inherited from

Source

parameters

Inherited from

Source

captureRejectionSymbol

Inherited from

Source

captureRejections

Inherited from

Source

defaultMaxListeners

Inherited from

Source

errorMonitor

Inherited from

Source

Methods

___cleanData()

Returns

Overrides

Source

__clean()

Returns

Inherited from

Abstract

Source

_cleanHash()

Parameters

Returns

Source

_cleanUsage()

Parameters

Returns

Overrides

Source

_get()

Parameters

Returns

Overrides

Inherit Doc