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

    Class Jsonb<N>

    Type Parameters

    • in out N extends number

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    [meta] deserialize __typname __typnameText

    Methods

    - -> ->> ? @? @@ @> < <@ <= <> = > >= || anyValue anyValueTransfn arrayAgg arrayPrepend bool cast coalesce count cumeDist denseRank elemContainedByMultirange elemContainedByRange eq float4 float8 gt gte in int2 int4 int8 isNotNull isNull jsonAgg jsonAggStrict jsonbAgg jsonbAggStrict jsonbArrayElement jsonbArrayElements jsonbArrayElementsText jsonbArrayElementText jsonbArrayLength jsonbConcat jsonbContained jsonbContains jsonbEach jsonbEachText jsonbExists jsonbObjectAgg jsonbObjectAggStrict jsonbObjectAggUnique jsonbObjectAggUniqueStrict jsonbObjectField jsonbObjectFieldText jsonbObjectKeys jsonbPathExists jsonbPathExistsOpr jsonbPathMatch jsonbPathMatchOpr jsonbPathQuery jsonbPathQueryArray jsonbPathQueryFirst jsonbPretty jsonbSend jsonbStripNulls jsonbTypeof jsonObjectAgg jsonObjectAggStrict jsonObjectAggUnique jsonObjectAggUniqueStrict lt lte minus mode ne numeric numNonnulls numNulls percentRank rank toSql column from serialize

    Constructors

    Properties

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

    Static__typname

    __typname: Raw = ...

    Static__typnameText

    __typnameText: string = "jsonb"

    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]>>>

    • Returns PgSrf<{ value: Text<1> }, "jsonb_array_elements_text">

    • Type Parameters

      • M0 extends string | Jsonpath<any>
      • M1 extends string | Jsonb<any>
      • M2 extends boolean | Bool<any>

      Parameters

      Returns PgSrf<
          {
              jsonb_path_query: Jsonb<
                  StrictNull<N | NullOf<M0> | NullOf<M1> | NullOf<M2>>,
              >;
          },
          "jsonb_path_query",
      >

    • 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
    -->->>?@?@@@><<@<=<>=>>=||anyValueanyValueTransfnarrayAggarrayPrependboolcastcoalescecountcumeDistdenseRankelemContainedByMultirangeelemContainedByRangeeqfloat4float8gtgteinint2int4int8isNotNullisNulljsonAggjsonAggStrictjsonbAggjsonbAggStrictjsonbArrayElementjsonbArrayElementsjsonbArrayElementsTextjsonbArrayElementTextjsonbArrayLengthjsonbConcatjsonbContainedjsonbContainsjsonbEachjsonbEachTextjsonbExistsjsonbObjectAggjsonbObjectAggStrictjsonbObjectAggUniquejsonbObjectAggUniqueStrictjsonbObjectFieldjsonbObjectFieldTextjsonbObjectKeysjsonbPathExistsjsonbPathExistsOprjsonbPathMatchjsonbPathMatchOprjsonbPathQueryjsonbPathQueryArrayjsonbPathQueryFirstjsonbPrettyjsonbSendjsonbStripNullsjsonbTypeofjsonObjectAggjsonObjectAggStrictjsonObjectAggUniquejsonObjectAggUniqueStrictltlteminusmodenenumericnumNonnullsnumNullspercentRankranktoSqlcolumnfromserialize