Typegres API Reference - v0.2.0
    Preparing search index...

    Class Tsvector<N>

    Type Parameters

    • in out N extends number

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    [meta] deserialize __typname __typnameText

    Methods

    @@ @@@ < <= <> = > >= || anyValue anyValueTransfn arrayAgg arrayPrepend cast coalesce count cumeDist denseRank elemContainedByMultirange elemContainedByRange eq gt gte in isNotNull isNull jsonAgg jsonAggStrict jsonbAgg jsonbAggStrict jsonbObjectAgg jsonbObjectAggStrict jsonbObjectAggUnique jsonbObjectAggUniqueStrict jsonObjectAgg jsonObjectAggStrict jsonObjectAggUnique jsonObjectAggUniqueStrict length lt lte mode ne numNonnulls numNulls percentRank rank setweight strip toSql tsDelete tsMatchVq tsRank tsRankCd tsvectorConcat tsvectorsend unnest column from serialize

    Constructors

    Properties

    "[meta]": {
        __aggregate: Tsvector<number>;
        __any: Tsvector<any>;
        __class: typeof Tsvector;
        __nonNullable: Tsvector<1>;
        __nullability: N;
        __nullable: Tsvector<0 | 1>;
        __raw: Sql;
    }
    deserialize: (raw: string) => string

    Static__typname

    __typname: Raw = ...

    Static__typnameText

    __typnameText: string = "tsvector"

    Methods

    @@

    @@@

    <

    <=

    <>

    =

    >

    >=

    ||

    • Type Parameters

      • T extends typeof Any

      Parameters

      • cls: T

      Returns [number] extends [N]
          ? InstanceType<T> extends { "[meta]": { __aggregate: U } }
              ? U
              : InstanceType<T>
          : [N] extends [1]
              ? InstanceType<T> extends { "[meta]": { __nonNullable: U } }
                  ? U
                  : InstanceType<T>
              : InstanceType<T> extends { "[meta]": { __nullable: U } }
                  ? U
                  : InstanceType<T>

    • Type Parameters

      • T extends Any<any>
      • R extends Any<any>

      Parameters

      • this: T
      • rhs: R

      Returns 0 extends NullOf<R> ? T : T extends { "[meta]": { __nonNullable: U } } ? U : T

    • Type Parameters

      • T extends Any<any>
      • Vs extends [
            (T extends { "[meta]": { __any: A } } ? A : Any<any>)
            | TsTypeOf<T>,
            ...(TsTypeOf<T> | (T extends { "[meta]": { __any: A } } ? A : Any<any>))[],
        ]

      Parameters

      • this: T
      • ...vals: Vs

      Returns Bool<StrictNull<NullOf<T> | NullOf<Vs[number]>>>

    • Type Parameters

      • T extends typeof Any
      • Opts extends ColumnOpts = {}

      Parameters

      • this: T
      • Optional_opts: Opts

      Returns InstanceType<T> & {
          "[meta]": {
              __required: Opts extends { nonNull: true }
                  ? Opts extends { default: any } | { generated: true } ? false : true
                  : false;
          };
      }

    • Type Parameters

      • T extends typeof Any

      Parameters

      Returns InstanceType<T> extends { "[meta]": { __nullable: U } } ? U : InstanceType<T>

    • Type Parameters

      • T extends typeof Any

      Parameters

      • this: T
      • v: unknown

      Returns InstanceType<T> extends { "[meta]": { __nonNullable: U } } ? U : InstanceType<T>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods