Skip to main content
Version: Next

@olympeio/documentation/olympe

Index

Classes

Enumerations

Functions

Interfaces

Namespaces

Type Aliases

Variables

Type Aliases

CacheStatus

CacheStatus: { files: { processed: number; total: number }; processing: boolean; queries: { processed: number; total: number } }

Type declaration

  • files: { processed: number; total: number }
    • processed: number
    • total: number
  • processing: boolean
  • queries: { processed: number; total: number }
    • processed: number
    • total: number

Class

Class<T>: new () => T

Type parameters

  • T

Type declaration

    • new (): T

    • Returns T

FollowRule

FollowRule: Property<number>

FunctionBrick

FunctionBrick: Brick
@deprecated

use Brick instead

ImplicitQueryOption

ImplicitQueryOption: { storeInCacheDB?: boolean }

Type declaration

  • optionalstoreInCacheDB?: boolean

InstanceOrTag

InstanceOrTag: string | HasTag | typeof CloudObject

A InstanceOrTag can be either a string, a HasTag (CloudObject instance, Property, Relation, …) or the class constructor for a CloudObject

InstanceTag

InstanceTag: InstanceOrTag | Entry

List

List<T>: T[] | (T extends CloudObject | CloudObject[] ? QueryResult<T> : never)

Type parameters

  • T

Operation

Operation: { model: string; object: string; properties?: Map<string, any>; type: CREATE } | { model: string; object: string; properties: Map<string, any>; type: UPDATE } | { model: string; object: string; type: DELETE } | { from: string; fromModel: string; relation: string; to: string; toModel: string; type: CREATE_RELATION } | { from: string; fromModel: string; relation: string; to: string; toModel: string; type: DELETE_RELATION }

Represents an operation that can be performed regarding data type instances.

ParsedPredicate

ParsedPredicate: { name: IS; tags: string[] } | { caseSensitive: boolean; name: CONTAINS; property: string; value: string } | { name: EQUALS; property: string; value: any } | { name: INEQUALITY_OPERATOR; operator: string; property: string; strict: boolean; value: any } | { name: NOT; predicate: ParsedPredicate } | { caseSensitive: boolean; name: REGEX; pattern: RegExp; property: string }

Details for a predicate from the OLYMPE query API

QueryOptions

QueryOptions: { cacheBucketName?: string }

Type declaration

  • optionalcacheBucketName?: string

SRPData

SRPData: { login: string; salt: string; username: string; verifier: string }

Type declaration

  • login: string
  • salt: string
  • username: string
  • verifier: string

Source

Source: PredefinedDataSource | string

When manipulating CloudObjects, sometimes it is required to manually set the data source of that object. Source determines where the object comes from: what data source is the owner of the object across the ecosystem.

TransactionOptions

TransactionOptions: { batch: boolean }

Additional options for transactions to be processed by a data source.

  • batch: if true, it means that the transaction has been executed using the Transaction.executeAsLarge() function.

Type declaration

  • batch: boolean

UserToken

UserToken: { idpName: string; nonce: string; payload: Object; protocol: AuthProtocol; user: string; userTag: string }

Type declaration

  • idpName: string
  • nonce: string
  • payload: Object
  • protocol: AuthProtocol
  • user: string
  • userTag: string

Variables

constRelation

Relation: RelationConstructor

Global variable, constructor of class Relation.