Options
All
  • Public
  • Public/Protected
  • All
Menu

A database model representing an ActivityPub Follow

Hierarchy

Index

Constructors

constructor

Properties

$modelClass

$modelClass: ModelClass<APFollow>

QueryBuilderType

QueryBuilderType: QueryBuilder<APFollow, APFollow[]>

actorFollower

actorFollower: APActor

actorFollowing

actorFollowing: APActor

actorId

actorId: string

createdAt

createdAt: string

id

id: string

state

state: FollowState

targetActorId

targetActorId: string

updatedAt

updatedAt: string

uri

uri: string

Static BelongsToOneRelation

BelongsToOneRelation: RelationType

Static HasManyRelation

HasManyRelation: RelationType

Static HasOneRelation

HasOneRelation: RelationType

Static HasOneThroughRelation

HasOneThroughRelation: RelationType

Static JoinEagerAlgorithm

JoinEagerAlgorithm: EagerAlgorithm

Static ManyToManyRelation

ManyToManyRelation: RelationType

Static NaiveEagerAlgorithm

NaiveEagerAlgorithm: EagerAlgorithm

Static QueryBuilder

QueryBuilder: typeof QueryBuilder

Static WhereInEagerAlgorithm

WhereInEagerAlgorithm: EagerAlgorithm

Static columnNameMappers

columnNameMappers: ColumnNameMappers

Static dbRefProp

dbRefProp: string

Static Optional defaultEagerAlgorithm

defaultEagerAlgorithm: EagerAlgorithm

Static Optional defaultEagerOptions

defaultEagerOptions: EagerOptions

Static Optional defaultGraphOptions

defaultGraphOptions: GraphOptions

Static fn

fn: FunctionFunction

Static idColumn

idColumn: string | string[]

Static jsonAttributes

jsonAttributes: string[]

Static jsonSchema

jsonSchema: JSONSchema

Static modelPaths

modelPaths: string[]

Static modifiers

modifiers: Modifiers<AnyQueryBuilder>

Static pickJsonSchemaProperties

pickJsonSchemaProperties: boolean

Static propRefRegex

propRefRegex: RegExp

Static raw

raw: RawFunction

Static ref

ref: ReferenceFunction

Static relatedFindQueryMutates

relatedFindQueryMutates: boolean

Static relatedInsertQueryMutates

relatedInsertQueryMutates: boolean

Static uidProp

uidProp: string

Static uidRefProp

uidRefProp: string

Static useLimitInFirst

useLimitInFirst: boolean

Static virtualAttributes

virtualAttributes: string[]

Accessors

Static tableName

  • get tableName(): string
  • Returns string

Methods

$afterDelete

  • $afterDelete(queryContext: QueryContext): void | Promise<any>
  • Parameters

    • queryContext: QueryContext

    Returns void | Promise<any>

$afterFind

  • $afterFind(queryContext: QueryContext): void | Promise<any>
  • Parameters

    • queryContext: QueryContext

    Returns void | Promise<any>

$afterGet

  • $afterGet(queryContext: QueryContext): void | Promise<any>
  • Parameters

    • queryContext: QueryContext

    Returns void | Promise<any>

$afterInsert

  • $afterInsert(queryContext: QueryContext): void | Promise<any>
  • Parameters

    • queryContext: QueryContext

    Returns void | Promise<any>

$afterUpdate

  • $afterUpdate(opt: ModelOptions, queryContext: QueryContext): void | Promise<any>
  • Parameters

    • opt: ModelOptions
    • queryContext: QueryContext

    Returns void | Promise<any>

$afterValidate

  • $afterValidate(json: Pojo, opt: ModelOptions): void
  • Parameters

    • json: Pojo
    • opt: ModelOptions

    Returns void

$appendRelated

  • $appendRelated<RM>(relation: String | Relation, related: undefined | null | RM | RM[]): APFollow
  • Type parameters

    • RM: Model<RM>

    Parameters

    • relation: String | Relation
    • related: undefined | null | RM | RM[]

    Returns APFollow

$beforeDelete

  • $beforeDelete(queryContext: QueryContext): void | Promise<any>
  • Parameters

    • queryContext: QueryContext

    Returns void | Promise<any>

$beforeInsert

  • $beforeInsert(queryContext: QueryContext): void | Promise<any>
  • Parameters

    • queryContext: QueryContext

    Returns void | Promise<any>

$beforeUpdate

  • $beforeUpdate(): void

$beforeValidate

  • $beforeValidate(jsonSchema: JSONSchema, json: Pojo, opt: ModelOptions): JSONSchema
  • Parameters

    • jsonSchema: JSONSchema
    • json: Pojo
    • opt: ModelOptions

    Returns JSONSchema

$clone

  • Parameters

    • Optional opt: CloneOptions

    Returns APFollow

$fetchGraph

  • $fetchGraph(expression: RelationExpression<M>, options?: FetchGraphOptions): QueryBuilder<APFollow, APFollow>
  • Parameters

    • expression: RelationExpression<M>
    • Optional options: FetchGraphOptions

    Returns QueryBuilder<APFollow, APFollow>

$formatDatabaseJson

  • $formatDatabaseJson(json: Pojo): Pojo
  • Parameters

    • json: Pojo

    Returns Pojo

$formatJson

  • $formatJson(json: Pojo): Pojo
  • Parameters

    • json: Pojo

    Returns Pojo

$id

  • $id(id: any): void
  • $id(): any
  • Parameters

    • id: any

    Returns void

  • Returns any

$knex

  • $knex(): any
  • Returns any

$loadRelated

  • Parameters

    • expression: RelationExpression<M>
    • Optional modifiers: Modifiers<QueryBuilder<APFollow, APFollow[]>>
    • Optional trxOrKnex: any

    Returns QueryBuilder<APFollow, APFollow>

$omit

  • $omit(keys: string | string[] | {}): APFollow
  • Parameters

    • keys: string | string[] | {}

    Returns APFollow

$parseDatabaseJson

  • $parseDatabaseJson(json: Pojo): Pojo
  • Parameters

    • json: Pojo

    Returns Pojo

$parseJson

  • $parseJson(json: Pojo, opt?: ModelOptions): Pojo
  • Parameters

    • json: Pojo
    • Optional opt: ModelOptions

    Returns Pojo

$pick

  • $pick(keys: string | string[] | {}): APFollow
  • Parameters

    • keys: string | string[] | {}

    Returns APFollow

$query

  • Parameters

    • Optional trxOrKnex: any

    Returns QueryBuilder<APFollow, APFollow>

$relatedQuery

  • $relatedQuery<K>(relationName: K, trxOrKnex?: any): RelatedQueryBuilder<APFollow[K]>
  • $relatedQuery<RM>(relationName: string, trxOrKnex?: any): QueryBuilderType<RM>
  • Type parameters

    Parameters

    • relationName: K
    • Optional trxOrKnex: any

    Returns RelatedQueryBuilder<APFollow[K]>

  • Type parameters

    • RM: Model<RM>

    Parameters

    • relationName: string
    • Optional trxOrKnex: any

    Returns QueryBuilderType<RM>

$set

  • Parameters

    • obj: Pojo

    Returns APFollow

$setDatabaseJson

  • $setDatabaseJson(json: object): APFollow

$setJson

  • $setJson(json: object, opt?: ModelOptions): APFollow
  • Parameters

    • json: object
    • Optional opt: ModelOptions

    Returns APFollow

$setRelated

  • $setRelated<RM>(relation: String | Relation, related: undefined | null | RM | RM[]): APFollow
  • Type parameters

    • RM: Model<RM>

    Parameters

    • relation: String | Relation
    • related: undefined | null | RM | RM[]

    Returns APFollow

$toDatabaseJson

  • $toDatabaseJson(): Pojo
  • Returns Pojo

$toJson

  • $toJson(opt?: ToJsonOptions): ModelObject<APFollow>
  • Parameters

    • Optional opt: ToJsonOptions

    Returns ModelObject<APFollow>

$transaction

  • $transaction(): any
  • Returns any

$traverse

  • $traverse(filterConstructor: typeof Model, traverser: TraverserFunction): APFollow
  • $traverse(traverser: TraverserFunction): APFollow
  • Parameters

    • filterConstructor: typeof Model
    • traverser: TraverserFunction

    Returns APFollow

  • Parameters

    • traverser: TraverserFunction

    Returns APFollow

$traverseAsync

  • $traverseAsync(filterConstructor: typeof Model, traverser: TraverserFunction): Promise<APFollow>
  • $traverseAsync(traverser: TraverserFunction): Promise<APFollow>
  • Parameters

    • filterConstructor: typeof Model
    • traverser: TraverserFunction

    Returns Promise<APFollow>

  • Parameters

    • traverser: TraverserFunction

    Returns Promise<APFollow>

$validate

  • $validate(json?: Pojo, opt?: ModelOptions): Pojo
  • Parameters

    • Optional json: Pojo
    • Optional opt: ModelOptions

    Returns Pojo

toJSON

  • toJSON(opt?: ToJsonOptions): ModelObject<APFollow>
  • Parameters

    • Optional opt: ToJsonOptions

    Returns ModelObject<APFollow>

Static afterDelete

  • afterDelete(args: StaticHookArguments<any, any>): any
  • Parameters

    • args: StaticHookArguments<any, any>

    Returns any

Static afterFind

  • afterFind(args: StaticHookArguments<any, any>): any
  • Parameters

    • args: StaticHookArguments<any, any>

    Returns any

Static afterInsert

  • afterInsert(args: StaticHookArguments<any, any>): any
  • Parameters

    • args: StaticHookArguments<any, any>

    Returns any

Static afterUpdate

  • afterUpdate(args: StaticHookArguments<any, any>): any
  • Parameters

    • args: StaticHookArguments<any, any>

    Returns any

Static beforeDelete

  • beforeDelete(args: StaticHookArguments<any, any>): any
  • Parameters

    • args: StaticHookArguments<any, any>

    Returns any

Static beforeFind

  • beforeFind(args: StaticHookArguments<any, any>): any
  • Parameters

    • args: StaticHookArguments<any, any>

    Returns any

Static beforeInsert

  • beforeInsert(args: StaticHookArguments<any, any>): any
  • Parameters

    • args: StaticHookArguments<any, any>

    Returns any

Static beforeUpdate

  • beforeUpdate(args: StaticHookArguments<any, any>): any
  • Parameters

    • args: StaticHookArguments<any, any>

    Returns any

Static bindKnex

  • bindKnex<M>(trxOrKnex: any): M
  • Type parameters

    • M

    Parameters

    • trxOrKnex: any

    Returns M

Static bindTransaction

  • bindTransaction<M>(trxOrKnex: any): M
  • Type parameters

    • M

    Parameters

    • trxOrKnex: any

    Returns M

Static createNotFoundError

  • createNotFoundError(queryContext: QueryContext, args: CreateNotFoundErrorArgs): Error
  • Parameters

    • queryContext: QueryContext
    • args: CreateNotFoundErrorArgs

    Returns Error

Static createValidationError

  • createValidationError(args: CreateValidationErrorArgs): Error
  • Parameters

    • args: CreateValidationErrorArgs

    Returns Error

Static createValidator

  • createValidator(): Validator

Static fetchGraph

  • fetchGraph<M>(modelOrObject: PartialModelObject<M>, expression: RelationExpression<M>, options?: FetchGraphOptions): SingleQueryBuilder<QueryBuilderType<M>>
  • fetchGraph<M>(modelOrObject: PartialModelObject<M>[], expression: RelationExpression<M>, options?: FetchGraphOptions): QueryBuilderType<M>
  • Type parameters

    • M: Model<M>

    Parameters

    • modelOrObject: PartialModelObject<M>
    • expression: RelationExpression<M>
    • Optional options: FetchGraphOptions

    Returns SingleQueryBuilder<QueryBuilderType<M>>

  • Type parameters

    • M: Model<M>

    Parameters

    • modelOrObject: PartialModelObject<M>[]
    • expression: RelationExpression<M>
    • Optional options: FetchGraphOptions

    Returns QueryBuilderType<M>

Static fetchTableMetadata

  • fetchTableMetadata(opt?: FetchTableMetadataOptions): Promise<TableMetadata>
  • Parameters

    • Optional opt: FetchTableMetadataOptions

    Returns Promise<TableMetadata>

Static fromDatabaseJson

  • fromDatabaseJson<M>(json: object): M
  • Type parameters

    • M: Model<M>

    Parameters

    • json: object

    Returns M

Static fromJson

  • fromJson<M>(json: object, opt?: ModelOptions): M
  • Type parameters

    • M: Model<M>

    Parameters

    • json: object
    • Optional opt: ModelOptions

    Returns M

Static getRelation

  • getRelation(name: string): Relation
  • Parameters

    • name: string

    Returns Relation

Static getRelations

  • getRelations(): Relations
  • Returns Relations

Static knex

  • knex(knex?: any): any
  • Parameters

    • Optional knex: any

    Returns any

Static knexQuery

  • knexQuery(): any
  • Returns any

Static loadRelated

  • loadRelated<M>(modelOrObject: PartialModelObject<M>, expression: RelationExpression<M>, modifiers?: Modifiers<QueryBuilderType<M>>, trxOrKnex?: any): SingleQueryBuilder<QueryBuilderType<M>>
  • loadRelated<M>(modelOrObject: PartialModelObject<M>[], expression: RelationExpression<M>, modifiers?: Modifiers<QueryBuilderType<M>>, trxOrKnex?: any): QueryBuilderType<M>
  • Type parameters

    • M: Model<M>

    Parameters

    • modelOrObject: PartialModelObject<M>
    • expression: RelationExpression<M>
    • Optional modifiers: Modifiers<QueryBuilderType<M>>
    • Optional trxOrKnex: any

    Returns SingleQueryBuilder<QueryBuilderType<M>>

  • Type parameters

    • M: Model<M>

    Parameters

    • modelOrObject: PartialModelObject<M>[]
    • expression: RelationExpression<M>
    • Optional modifiers: Modifiers<QueryBuilderType<M>>
    • Optional trxOrKnex: any

    Returns QueryBuilderType<M>

Static query

  • query<M>(trxOrKnex?: any): QueryBuilderType<M>
  • Type parameters

    • M: Model<M>

    Parameters

    • Optional trxOrKnex: any

    Returns QueryBuilderType<M>

Static relatedQuery

  • relatedQuery<M, K>(relationName: K, trxOrKnex?: any): ArrayRelatedQueryBuilder<M[K]>
  • relatedQuery<RM>(relationName: string, trxOrKnex?: any): QueryBuilderType<RM>
  • Type parameters

    • M: Model<M>

    • K: string | number | symbol

    Parameters

    • relationName: K
    • Optional trxOrKnex: any

    Returns ArrayRelatedQueryBuilder<M[K]>

  • Type parameters

    • RM: Model<RM>

    Parameters

    • relationName: string
    • Optional trxOrKnex: any

    Returns QueryBuilderType<RM>

Static relationMappings

  • relationMappings(): RelationMappings
  • Returns RelationMappings

Static startTransaction

  • startTransaction(knexOrTransaction?: any): Promise<any>
  • Parameters

    • Optional knexOrTransaction: any

    Returns Promise<any>

Static tableMetadata

  • tableMetadata(opt?: TableMetadataOptions): TableMetadata
  • Parameters

    • Optional opt: TableMetadataOptions

    Returns TableMetadata

Static transaction

  • transaction<T>(callback: (trx: any) => Promise<T>): Promise<T>
  • transaction<T>(trxOrKnex: any, callback: (trx: any) => Promise<T>): Promise<T>
  • Type parameters

    • T

    Parameters

    • callback: (trx: any) => Promise<T>
        • (trx: any): Promise<T>
        • Parameters

          • trx: any

          Returns Promise<T>

    Returns Promise<T>

  • Type parameters

    • T

    Parameters

    • trxOrKnex: any
    • callback: (trx: any) => Promise<T>
        • (trx: any): Promise<T>
        • Parameters

          • trx: any

          Returns Promise<T>

    Returns Promise<T>

Static traverse

  • traverse(models: Model | Model[], traverser: TraverserFunction): void
  • traverse(filterConstructor: typeof Model, models: Model | Model[], traverser: TraverserFunction): void
  • Parameters

    • models: Model | Model[]
    • traverser: TraverserFunction

    Returns void

  • Parameters

    • filterConstructor: typeof Model
    • models: Model | Model[]
    • traverser: TraverserFunction

    Returns void

Generated using TypeDoc