FileBinary

Class: FileBinary<T>

Defined in: fs/src/filebinary.service.ts:108

FileBinary handles the storage of binary on a hard drive

The structure used for now is /folder/{hash}/data /folder/{hash}/{model}{attribute}{uuid} usage markers /folder/{hash}/vproof_{challenge} proof of possession, written by the service from the bytes it read

Legacy proofs are ignored (a leaked value attaches nothing): _{challenge} (before 4.0.0-beta.5, the challenge was sent to clients) and proof_{challenge} (written before every proof was computed by the service). The content is uploaded once more to get a vproof_ marker.

It takes one parameter folder: "path"

See Binary the general interface

Webda Modda

Extends

CloudBinary<T>

Type Parameters

T

T extends FileBinaryParameters = FileBinaryParameters

Constructors

Constructor

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

Defined in: core/lib/services/service.d.ts:72

Service

Parameters

name

string

The name of the service

params

T

The parameters block define in the configuration file

Returns

FileBinary<T>

Inherited from

CloudBinary<T>.constructor

Properties

_compiledCapabilities

protected _compiledCapabilities: Record<string, any>

Defined in: core/lib/services/iservice.d.ts:38

Capabilities detected at compile-time from @WebdaCapability-tagged interfaces.

Populated during Service.resolve by reading the service's entry in webda.module.json. Each key is a capability name (e.g., "request-filter"), and the value is an empty object {} by default. Override getCapabilities to provide capability-specific configuration or to conditionally disable capabilities.

See

getCapabilities

Inherited from

FileQueue._compiledCapabilities

_lowercaseMaps

_lowercaseMaps: any

Defined in: core/lib/services/binary.service.d.ts:746

Inherited from

CloudBinary._lowercaseMaps

[WEBDA_EVENTS]

[WEBDA_EVENTS]: BinaryEvents

Defined in: core/lib/services/service.d.ts:50

Set the Webda events here

Inherited from

CloudBinary.[WEBDA_EVENTS]

cryptoService

cryptoService: CryptoService

Defined in: fs/src/filebinary.service.ts:114

Used for hmac

hookedModels

protected hookedModels: Set<string>

Defined in: core/lib/services/binary.service.d.ts:854

Identifiers of the models whose deletion is already followed, so a second init() does not cascade twice

Inherited from

CloudBinary.hookedModels

logger

protected logger: Logger

Defined in: core/lib/services/service.d.ts:59

Logger with class context

Inherited from

FileQueue.logger

metrics

metrics: object

Defined in: core/lib/services/binary.service.d.ts:747

Get metrics

delete

delete: Counter

download

download: Counter

metadataUpdate

metadataUpdate: Counter

upload

upload: Counter

Inherited from

CloudBinary.metrics

name

readonly name: string

Defined in: core/lib/services/iservice.d.ts:18

Inherited from

FileQueue.name

parameters

readonly parameters: T

Defined in: core/lib/services/iservice.d.ts:19

Inherited from

CloudBinary.parameters

pendingDeletes

protected pendingDeletes: Map<string, { infos: object[]; model: string; uuid: string; }>

Defined in: core/lib/services/binary.service.d.ts:843

Binaries of a deleted object, kept between the Delete (before) and Deleted (after) events of its repository

Inherited from

CloudBinary.pendingDeletes

schemes

readonly schemes: string[]

Defined in: fs/src/filebinary.service.ts:109

Schemes handled, without ':' e.g. ["s3"], ["gs", "gcs"]

Overrides

CloudBinary.schemes

createConfiguration?

static optional createConfiguration?: (params) => any

Defined in: core/lib/services/iservice.d.ts:23

Create configuration set by the application on load

Parameters

params

any

Returns

any

Inherited from

CloudBinary.createConfiguration

filterConfiguration?

static optional filterConfiguration?: (params) => any

Defined in: core/lib/services/iservice.d.ts:27

Create configuration set by the application on load

Parameters

params

any

Returns

any

Inherited from

CloudBinary.filterConfiguration

Parameters

static Parameters: typeof ServiceParameters

Defined in: core/lib/services/service.d.ts:46

Service parameters

Inherited from

CloudBinary.Parameters

Methods

___cleanData()

___cleanData(): Promise<void>

Defined in: fs/src/filebinary.service.ts:727

Clean all data

Returns

Promise<void>

Overrides

CloudBinary.___cleanData

__clean()

abstract __clean(): Promise<void>

Defined in: core/lib/services/service.d.ts:215

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

Returns

Promise<void>

Inherited from

CloudBinary.__clean

_cleanHash()

_cleanHash(hash): Promise<void>

Defined in: fs/src/filebinary.service.ts:578

Delete any usage marker and hash

Parameters

hash

string

the content hash to clean

Returns

Promise<void>

_cleanUsage()

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

Defined in: fs/src/filebinary.service.ts:591

Parameters

hash

string

uuid

string

attribute

string

model?

string

Returns

Promise<void>

Overrides

CloudBinary._cleanUsage

_get()

_get(info): Promise<Readable>

Defined in: fs/src/filebinary.service.ts:313

Parameters

info

BinaryMap

Returns

Promise<Readable>

Overrides

CloudBinary._get

_getKey()

_getKey(hash, suffix?): string

Defined in: core/lib/services/cloudbinary.d.ts:79

Return the S3 key

Parameters

hash

string

the hash value

suffix?

string

the suffix to append

Returns

string

the result string

Inherited from

CloudBinary._getKey

_getPath()

_getPath(hash, postfix?): string

Defined in: fs/src/filebinary.service.ts:352

Get storage path for a hash

Parameters

hash

string | undefined

the content hash

postfix?

string

optional path suffix

Returns

string

the filesystem path

_store()

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

Defined in: fs/src/filebinary.service.ts:680

Write a binary file's stream to the local filesystem under its content-hash directory.

Parameters

file

BinaryFile

the binary file to store

object

CoreModel

the model instance

attribute

string

the binary attribute name

Returns

Promise<void>

_touch()

_touch(filePath, mode?): void

Defined in: fs/src/filebinary.service.ts:366

Create a file if it does not already exist, using the given permission mode.

Parameters

filePath

string

path of the file to create

mode?

number = 0o600

file permission mode

Returns

void

addListener()

addListener<Key>(eventName, listener): this

Defined in: core/lib/events/asynceventemitter.d.ts:80

Type Parameters

Key

Key extends keyof BinaryEvents

Parameters

eventName

Key

the event name

listener

(event) => void | Promise<void>

the event listener

Returns

this

this for chaining

See

EventEmitter.addListener

Inherited from

CloudBinary.addListener

addRoute()

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

Defined in: core/lib/services/service.d.ts:177

Add a route dynamicaly

Parameters

url

string

of the route can contains dynamic part like {uuid}

methods

HttpMethodType[]

the HTTP methods

executer

Function

Method to execute for this route

openapi?

OpenAPIWebdaDefinition

the OpenAPI specification

override?

boolean

whether to override existing

Returns

void

Inherited from

CloudBinary.addRoute

attach()

protected attach(object, target, hashes): Promise<void>

Defined in: fs/src/filebinary.service.ts:438

Attach a stored binary to an object: usage marker, then the object's binary attribute

Parameters

object

CoreModel

the model instance

target

UploadTarget

the object attribute and the announced file information

hashes

the stored content

challenge

string

its challenge

hash

string

its hash

Returns

Promise<void>

authorizeClientEvent()

authorizeClientEvent(_event, _context): boolean

Defined in: core/lib/services/service.d.ts:153

Authorize a public event subscription

Parameters

_event

string

the event name

_context

OperationContext

the execution context

Returns

boolean

true if the condition is met

Inherited from

CloudBinary.authorizeClientEvent

cascadeDelete()

cascadeDelete(info, uuid, attribute, model): Promise<void>

Defined in: fs/src/filebinary.service.ts:668

Parameters

info

BinaryMap

uuid

string

attribute

string

model

string

Returns

Promise<void>

Overrides

CloudBinary.cascadeDelete

challenge()

challenge(hash, challenge): boolean

Defined in: fs/src/filebinary.service.ts:644

Verify that a binary with the given hash exists and carries the proof marker of the challenge, written by the service when the content was uploaded

Parameters

hash

string | undefined

the content hash

challenge

string | undefined

the challenge string

Returns

boolean

true if the proof marker exists

checkMap()

protected checkMap(object, property): void

Defined in: core/lib/services/binary.service.d.ts:892

Check if a map is defined

Parameters

object

Model

the target object

property

string

the property name

Returns

void

Inherited from

CloudBinary.checkMap

completeUpload()

completeUpload(object, property, hash): Promise<void>

Defined in: fs/src/filebinary.service.ts:560

The upload attaches the binary (storeBinary): completing only checks it happened

Parameters

object

CoreModelWithBinary

the model owning the binary

property

string

the binary attribute

hash

string

the hash announced in the challenge

Returns

Promise<void>

Overrides

CloudBinary.completeUpload

computeParameters()

computeParameters(): void

Defined in: fs/src/filebinary.service.ts:212

Create the storage folder if needed

Returns

void

Overrides

CloudBinary.computeParameters

delete()

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

Defined in: fs/src/filebinary.service.ts:613

Parameters

object

CoreModelWithBinary

property

string

index?

number

Returns

Promise<void>

Overrides

CloudBinary.delete

deleteContent()

deleteContent(url): Promise<void>

Defined in: fs/src/filebinary.service.ts:204

Delete content

Parameters

url

string

content URL

Returns

Promise<void>

Overrides

CloudBinary.deleteContent

deleteSuccess()

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

Defined in: core/lib/services/binary.service.d.ts:960

Parameters

object

CoreModelWithBinary

the target object

property

string

the property name

index?

number

the index

Returns

Promise<void>

the result

Inherited from

CloudBinary.deleteSuccess

downloadBinaryLink()

downloadBinaryLink(ctx): Promise<void>

Defined in: fs/src/filebinary.service.ts:286

Download a binary with a signed download token (issued by the download behavior action, after the model's permission check)

Parameters

ctx

WebContext<any, any, { hash: string; }>

the web context

Returns

Promise<void>

downloadTo()

downloadTo(info, filename): Promise<void>

Defined in: core/lib/services/binary.service.d.ts:825

Download a binary to a file

Parameters

info

BinaryMap

The reference stored in your target object

filename

any

the filename

Returns

Promise<void>

Inherited from

CloudBinary.downloadTo

emit()

emit<Key>(event, data): Promise<void>

Defined in: core/lib/services/service.d.ts:204

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

Type Parameters

Key

Key extends keyof BinaryEvents

Parameters

event

Key

the event name

data

BinaryEvents[Key]

the data to process

Returns

Promise<void>

Inherited from

CloudBinary.emit

get()

get(info): Promise<Readable>

Defined in: core/lib/services/binary.service.d.ts:817

Get a binary

Parameters

info

BinaryMap

The reference stored in your target object

Returns

Promise<Readable>

the result

Emits

'binaryGet'

Inherited from

CloudBinary.get

getCapabilities()

getCapabilities(): Record<string, any>

Defined in: core/lib/services/iservice.d.ts:60

Return the capabilities of this service.

By default returns capabilities detected at compile-time from

Returns

Record<string, any>

the result

Webda Capability-tagged

interfaces in webda.module.json.

Override to disable capabilities based on configuration:

getCapabilities() {
  const caps = super.getCapabilities();
  if (!this.parameters.enabled) delete caps["request-filter"];
  return caps;
}

Inherited from

CloudBinary.getCapabilities

getClientEvents()

getClientEvents(): string[]

Defined in: core/lib/services/service.d.ts:144

Return the events that an external system can subscribe to

Returns

string[]

the list of results

Inherited from

CloudBinary.getClientEvents

getContent()

getContent(url, options?): Promise<Readable>

Defined in: fs/src/filebinary.service.ts:161

Get content read stream

Parameters

url

string

content URL

options?

ContentGetOptions

get options

Returns

Promise<Readable>

Readable stream

Overrides

CloudBinary.getContent

getContentBucket()

getContentBucket(): string | undefined

Defined in: core/lib/services/cloudbinary.d.ts:49

Get bucket to register in ContentStorages

Returns

string | undefined

bucket name or undefined

Inherited from

CloudBinary.getContentBucket

getContentUrl()

protected getContentUrl(key): string

Defined in: fs/src/filebinary.service.ts:149

Helper that builds file:// URL under this.parameters.folder

Parameters

key

string

relative key

Returns

string

file:// URL

Overrides

CloudBinary.getContentUrl

getFile()

getFile(req): Promise<BinaryFile<{ }>>

Defined in: core/lib/services/binary.service.d.ts:966

Get file either from multipart post or raw

Parameters

req

IOperationContext

the request

Returns

Promise<BinaryFile<{ }>>

the result

Inherited from

CloudBinary.getFile

getMaxListeners()

getMaxListeners(): number

Defined in: core/lib/events/asynceventemitter.d.ts:84

Returns

number

Inherited from

CloudBinary.getMaxListeners

getMetric()

getMetric<T>(type, configuration): T

Defined in: core/lib/services/service.d.ts:138

Add service name label

Type Parameters

T

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

Parameters

type

CustomConstructor<T, [MetricConfiguration<T>]>

the type to look up

configuration

MetricConfiguration<T>

the configuration

Returns

T

the result

Inherited from

CloudBinary.getMetric

getName()

getName(): string

Defined in: core/lib/services/service.d.ts:209

Get service name

Returns

string

the result string

Inherited from

CloudBinary.getName

getOpenApiReplacements()

getOpenApiReplacements(): any

Defined in: core/lib/services/service.d.ts:182

Return variables for replacement in openapi

Returns

any

the result

Inherited from

CloudBinary.getOpenApiReplacements

getOperationId()

getOperationId(id): string | undefined

Defined in: core/lib/services/service.d.ts:167

If undefined is returned it cancel the operation registration

Parameters

id

string

the identifier

Returns

string | undefined

the result

Inherited from

CloudBinary.getOperationId

getOperationName()

protected getOperationName(): string

Defined in: core/lib/services/binary.service.d.ts:971

Return the name of the service for OpenAPI

Returns

string

the result string

Inherited from

CloudBinary.getOperationName

getParameters()

getParameters(): T

Defined in: core/lib/services/service.d.ts:82

Get the service parameters

Returns

T

the result

Inherited from

CloudBinary.getParameters

getPutUrl()

getPutUrl(ctx, hash?, target?): Promise<string>

Defined in: fs/src/filebinary.service.ts:402

Get put URL

Parameters

ctx

OperationContext<BinaryFile<{ }>, any, any> | undefined

the operation context

hash?

string

the content hash (read from the input when not given)

target?

UploadTarget

what the upload attaches once the content is stored and verified

Returns

Promise<string>

the upload URL

getRedirectUrlFromObject()

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

Defined in: core/lib/services/cloudbinary.d.ts:72

Get a UrlFromObject

Parameters

binaryMap

any

the binary map definition

context

any

the execution context

expires?

number

the expiration time

Returns

Promise<string>

the result

Inherited from

CloudBinary.getRedirectUrlFromObject

getRepository()

protected getRepository(model): any

Defined in: core/lib/services/binary.service.d.ts:875

Get the event emitting repository of a model

Parameters

model

any

the model class

Returns

any

the repository

Inherited from

CloudBinary.getRepository

getService()

getService<T>(name): ServicesMap[T]

Defined in: core/lib/services/service.d.ts:131

Get a service by name

Type Parameters

T

T extends keyof ServicesMap

Parameters

name

T

the name to use

Returns

ServicesMap[T]

the result map

Deprecated

Use useService, might reconsider

Inherited from

CloudBinary.getService

getSignedUrlFromMap()

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

Defined in: fs/src/filebinary.service.ts:335

Get signed url to download an element

Parameters

map

BinaryMap

the binary map

expires

number

expiration time in seconds

context

WebContext

the web context

Returns

Promise<string>

the signed download URL

Overrides

CloudBinary.getSignedUrlFromMap

getState()

getState(): ServiceStates

Defined in: core/lib/services/service.d.ts:55

Get the current state

Returns

ServiceStates

the result

Inherited from

CloudBinary.getState

getStoredValue()

protected getStoredValue(object, property): Promise<any>

Defined in: core/lib/services/binary.service.d.ts:932

The attribute value as stored: the object is re-loaded from its repository so a link made by a concurrent request (another instance of the same object) is seen. Objects without a stored copy keep their own value.

Parameters

object

CoreModelWithBinary

the target object

property

string

the property name

Returns

Promise<any>

the attribute value

Inherited from

CloudBinary.getStoredValue

getToken()

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

Defined in: fs/src/filebinary.service.ts:384

Get token for action

Parameters

hash

string | undefined

the content hash

method

"PUT" | "GET"

HTTP method (PUT or GET)

expiresIn?

number = 60

token TTL in seconds

target?

UploadTarget

for an upload token, what to attach once the content is stored and verified

Returns

Promise<string>

the signed JWT token

getUrl()

getUrl(url, _methods): string

Defined in: core/lib/services/service.d.ts:161

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

getUsageCount()

getUsageCount(hash): Promise<number>

Defined in: fs/src/filebinary.service.ts:569

Parameters

hash

string

Returns

Promise<number>

Overrides

CloudBinary.getUsageCount

handleBinary()

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

Defined in: core/lib/services/binary.service.d.ts:772

Define if binary is managed by the store

Parameters

modelName

string

the model name

attribute

string

the attribute name

Returns

-1 | 0 | 1 | 2

-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

headContent()

headContent(url): Promise<ContentInfo | undefined>

Defined in: fs/src/filebinary.service.ts:190

Head content metadata

Parameters

url

string

content URL

Returns

Promise<ContentInfo | undefined>

Content info or undefined

Overrides

CloudBinary.headContent

hookDelete()

protected hookDelete(model, attributes): void

Defined in: core/lib/services/binary.service.d.ts:884

Cascade the deletion of a model to its binaries

Delete runs before the repository deletion: the object is loaded and its binaries are kept aside. Deleted only fires once the deletion succeeded, so a failed delete leaves the binaries untouched.

Parameters

model

any

the model class

attributes

string[]

the candidate behavior attributes

Returns

void

Inherited from

CloudBinary.hookDelete

init()

init(): Promise<FileBinary<T>>

Defined in: fs/src/filebinary.service.ts:230

Routes depend on the runtime parameters.url + content hash, so they're registered programmatically rather than via @Route.

Returns

Promise<FileBinary<T>>

this for chaining

Overrides

CloudBinary.init

initMetrics()

initMetrics(): void

Defined in: core/lib/services/binary.service.d.ts:756

Returns

void

Inherited from

CloudBinary.initMetrics

initOperations()

initOperations(): void

Defined in: core/lib/services/service.d.ts:186

Init the operations from

Returns

void

Operation

decorators on this service

Inherited from

CloudBinary.initOperations

isCollection()

protected isCollection(object, property): boolean

Defined in: core/lib/services/binary.service.d.ts:904

Whether the binary attribute is a collection (BinariesImpl or a subclass) rather than a single Binary

Models are hydrated by the compiled __hydrateBehaviors (store deserialization, load, patch), which always instantiates the behavior class, even for an unset attribute: instanceof BinariesImpl therefore covers subclasses. The relation id comparison is the fallback for objects that were never hydrated.

Parameters

object

CoreModelWithBinary

the target object

property

string

the property name

Returns

boolean

true if the attribute holds several binaries

Inherited from

CloudBinary.isCollection

isLinked()

protected isLinked(object, property, hash, value?): boolean

Defined in: core/lib/services/binary.service.d.ts:924

Whether the hash is already linked to the object attribute (a collection item or the single binary)

Parameters

object

CoreModelWithBinary

the target object

property

string

the property name

hash

string

the binary hash

value?

any

the attribute value to check, default to the object's

Returns

boolean

true if linked

Inherited from

CloudBinary.isLinked

listeners()

listeners(eventName): Function[]

Defined in: core/lib/events/asynceventemitter.d.ts:139

Get all listeners for an event

Parameters

eventName

keyof BinaryEvents

the event name

Returns

Function[]

the list of results

Inherited from

CloudBinary.listeners

loadCapabilities()

protected loadCapabilities(): void

Defined in: core/lib/services/service.d.ts:120

Load capabilities from webda.module.json metadata into _compiledCapabilities.

Called during resolve after dependency injection. Reads the service's type name from parameters, looks it up in the application's module metadata (moddas or beans section), and populates _compiledCapabilities with an empty object for each declared capability name.

Fails silently if the application is not available (e.g., in unit tests where services are instantiated without a full application context).

Returns

void

Example

// If webda.module.json contains:
// { "moddas": { "MyApp/HawkService": { "capabilities": ["request-filter", "cors-filter"] } } }
// Then after resolve(), this.getCapabilities() returns:
// { "request-filter": {}, "cors-filter": {} }

See

getCapabilities

Inherited from

CloudBinary.loadCapabilities

loadParameters()

loadParameters(params): T

Defined in: fs/src/filebinary.service.ts:121

Load parameters

Parameters

params

any

raw parameter values

Returns

T

the loaded parameters

log()

log(level, ...args): void

Defined in: core/lib/services/service.d.ts:226

Parameters

level

WorkerLogLevel

to log

args

...any[]

additional arguments

Returns

void

Inherited from

CloudBinary.log

newModel()

newModel(obj): BinaryMap

Defined in: core/lib/services/binary.service.d.ts:832

Based on the raw Map init a BinaryMap

Parameters

obj

any

the target object

Returns

BinaryMap

the result map

Inherited from

CloudBinary.newModel

off()

off<Key>(eventName, listener): this

Defined in: core/lib/events/asynceventemitter.d.ts:116

Type Parameters

Key

Key extends keyof BinaryEvents

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.off

Inherited from

CloudBinary.off

on()

on<Key>(eventName, listener): this

Defined in: core/lib/events/asynceventemitter.d.ts:102

Type Parameters

Key

Key extends keyof BinaryEvents

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.once

Inherited from

CloudBinary.on

once()

once<Key>(eventName, listener): this

Defined in: core/lib/events/asynceventemitter.d.ts:95

Type Parameters

Key

Key extends keyof BinaryEvents

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.once

Inherited from

CloudBinary.once

ownsAttribute()

protected ownsAttribute(model, attribute): boolean

Defined in: core/lib/services/binary.service.d.ts:869

Whether this service is the one storing the binaries of a model attribute

Parameters

model

any

the model class

attribute

string

the attribute name

Returns

boolean

true if owned

Inherited from

CloudBinary.ownsAttribute

proofMarker()

protected proofMarker(challenge): string

Defined in: fs/src/filebinary.service.ts:632

Name of the proof marker of a challenge computed by the service (legacy _<challenge> and proof_<challenge> markers are not proofs)

Parameters

challenge

string

the server computed challenge

Returns

string

the marker file name

putContent()

putContent(url, body, options?): Promise<ContentInfo>

Defined in: fs/src/filebinary.service.ts:173

Put content to filesystem

Parameters

url

string

content URL

body

ContentBody

content body

options?

ContentPutOptions

put options

Returns

Promise<ContentInfo>

Content info

Overrides

CloudBinary.putContent

putRedirectUrl()

putRedirectUrl(object, attribute, info?, context?): Promise<{ method: string; url: string; } | undefined>

Defined in: fs/src/filebinary.service.ts:467

Challenge: the client announces {hash, challenge, ...}; the challenge is the md5 of "WEBDA" + the content, so a matching one proves possession of an already stored binary, which is then attached without upload (undefined). Otherwise the upload URL is returned and nothing is attached yet: the upload stores the content, verifies it against the announced hash and attaches it then (storeBinary). A visible hash alone therefore never gives access to another object's binary.

Parameters

object

CoreModel

the model instance

attribute

string

the binary attribute name

info?

BinaryFile<{ }>

optional binary file info

context?

OperationContext<BinaryFile<{ }>, any, any>

the operation context

Returns

Promise<{ method: string; url: string; } | undefined>

the upload URL and method, or undefined when the binary is attached

Overrides

CloudBinary.putRedirectUrl

removeAllListeners()

removeAllListeners<Key>(eventName?): this

Defined in: core/lib/events/asynceventemitter.d.ts:122

Type Parameters

Key

Key extends keyof BinaryEvents

Parameters

eventName?

Key

the event name

Returns

this

this for chaining

See

EventEmitter.removeAllListeners

Inherited from

CloudBinary.removeAllListeners

removeListener()

removeListener<Key>(eventName, listener): this

Defined in: core/lib/events/asynceventemitter.d.ts:109

Type Parameters

Key

Key extends keyof BinaryEvents

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.removeListener

Inherited from

CloudBinary.removeListener

resolve()

resolve(): this

Defined in: core/lib/services/service.d.ts:98

Resolve parameters and load metadata. @Route-declared routes are scanned and registered by Router.discoverRoutes(services) from Core.init() once every service has resolved — nothing to do per-service here.

Returns

this

the result

Inherited from

CloudBinary.resolve

safeName()

protected safeName(part): string

Defined in: fs/src/filebinary.service.ts:417

Make a marker name part file-safe: the model identifier carries a /, and a natural key is client-chosen, so anything but letters, digits, _, ., :, @ and - is replaced (a marker is a file inside the hash folder)

Parameters

part

string

the raw value

Returns

string

the safe name part

setMaxListeners()

setMaxListeners(n): this

Defined in: core/lib/events/asynceventemitter.d.ts:88

Parameters

n

number

Returns

this

Inherited from

CloudBinary.setMaxListeners

stop()

stop(): Promise<void>

Defined in: core/lib/services/cloudbinary.d.ts:63

Returns

Promise<void>

Inherited from

CloudBinary.stop

store()

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

Defined in: fs/src/filebinary.service.ts:704

Parameters

object

CoreModel

property

string

file

BinaryFile

Returns

Promise<any>

Overrides

CloudBinary.store

storeBinary()

storeBinary(ctx): Promise<void>

Defined in: fs/src/filebinary.service.ts:507

Store the binary sent with an upload token, then attach it to the object the token names

Parameters

ctx

WebContext

the web context

Returns

Promise<void>

toJSON()

toJSON(): string

Defined in: core/lib/services/service.d.ts:191

Prevent service to be serialized

Returns

string

the result

Inherited from

CloudBinary.toJSON

toString()

toString(): string

Defined in: core/lib/services/service.d.ts:91

Return service representation

Returns

string

the result

Inherited from

CloudBinary.toString

uploadSuccess()

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

Defined in: core/lib/services/binary.service.d.ts:939

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

Parameters

object

CoreModelWithBinary

the target object

property

string

the property name

fileInfo

BinaryFileInfo<{ }> | { toBinaryFileInfo: () => BinaryFileInfo; }

the file information

Returns

Promise<void>

Inherited from

CloudBinary.uploadSuccess

usageMarker()

protected usageMarker(target): string

Defined in: fs/src/filebinary.service.ts:426

Usage marker of an object attribute in a hash folder: <model>_<attribute>_<uuid>, every part file-safe

Parameters

target

Pick<UploadTarget, "model" | "attribute" | "uuid">

the object attribute

Returns

string

the marker file name

usageMarkers()

protected usageMarkers(hash): string[]

Defined in: fs/src/filebinary.service.ts:655

Usage markers of a hash folder: every file but the data and the proof markers (legacy _ and proof_ included)

Parameters

hash

string

the content hash

Returns

string[]

the marker names

verifiedHashes()

protected verifiedHashes(file): Promise<{ challenge: string; hash: string; }>

Defined in: core/lib/services/binary.service.d.ts:912

Hashes of a file to store, computed from its bytes: a hash or challenge set on the file is never trusted

A preset hash that differs from the content is rejected; the file then carries the computed values

Parameters

file

BinaryFile

the file to store

Returns

Promise<{ challenge: string; hash: string; }>

the computed hash and challenge

Inherited from

CloudBinary.verifiedHashes

verifyMapAndStore()

protected verifyMapAndStore(ctx): IStore

Defined in: core/lib/services/binary.service.d.ts:977

Based on the request parameter verify it match a known mapping

Parameters

ctx

IOperationContext

the operation context

Returns

IStore

the result

Inherited from

CloudBinary.verifyMapAndStore

streamToBuffer()

static streamToBuffer(stream): Promise<Buffer<ArrayBufferLike>>

Defined in: core/lib/services/binary.service.d.ts:839

Read a stream to a buffer

Parameters

stream

Readable

the stream

Returns

Promise<Buffer<ArrayBufferLike>>

the result

Inherited from

CloudBinary.streamToBuffer

Class: FileBinary<T>

Webda Modda​

Extends​

Type Parameters​

T​

Constructors​

Constructor​

Parameters​

name​

params​

Returns​

Inherited from​

Properties​

_compiledCapabilities​

See​

Inherited from​

_lowercaseMaps​

Inherited from​

[WEBDA_EVENTS]​

Inherited from​

cryptoService​

hookedModels​

Inherited from​

logger​

Inherited from​

metrics​

delete​

download​

metadataUpdate​

upload​

Inherited from​

name​

Inherited from​

parameters​

Inherited from​

pendingDeletes​

Inherited from​

schemes​

Overrides​

createConfiguration?​

Parameters​

params​

Returns​

Inherited from​

filterConfiguration?​

Parameters​

params​

Returns​

Inherited from​

Parameters​

Inherited from​

Methods​

___cleanData()​

Returns​

Overrides​

__clean()​

Returns​

Inherited from​

_cleanHash()​

Parameters​

hash​

Returns​

_cleanUsage()​

Parameters​

hash​

uuid​

attribute​

model?​

Returns​

Overrides​

_get()​

Parameters​

info​

Returns​

Overrides​

_getKey()​

Parameters​

hash​

suffix?​

Returns​

Webda Modda

Extends

Type Parameters

T

Constructors

Constructor

Parameters

name

params

Returns

Inherited from

Properties

_compiledCapabilities

See

Inherited from

_lowercaseMaps

Inherited from

[WEBDA_EVENTS]

Inherited from

cryptoService

hookedModels

Inherited from

logger

Inherited from

metrics

delete

download

metadataUpdate

upload

Inherited from

name

Inherited from

parameters

Inherited from

pendingDeletes

Inherited from

schemes

Overrides

createConfiguration?

Parameters

params

Returns

Inherited from

filterConfiguration?

Parameters

params

Returns

Inherited from

Parameters

Inherited from

Methods

___cleanData()

Returns

Overrides

__clean()

Returns

Inherited from

_cleanHash()

Parameters

hash

Returns

_cleanUsage()

Parameters

hash

uuid

attribute

model?

Returns

Overrides

_get()

Parameters

info

Returns

Overrides

_getKey()

Parameters

hash

suffix?

Returns

Inherited from