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

    Class Text<N>

    Type Parameters

    • in out N extends number

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    [meta] deserialize __typname __typnameText

    Methods

    !~ !~* !~~ !~~* @@ ^@ < <= <> = > >= || ~ ~* ~<=~ ~<~ ~>=~ ~>~ ~~ ~~* anyValue anyValueTransfn arrayAgg arrayPrepend ascii bitLength btrim cast char characterLength charLength coalesce count cumeDist datePart dateTrunc decode denseRank elemContainedByMultirange elemContainedByRange eq extract gt gte in initcap isNormalized isNotNull isNull jsonAgg jsonAggStrict jsonbAgg jsonbAggStrict jsonbObjectAgg jsonbObjectAggStrict jsonbObjectAggUnique jsonbObjectAggUniqueStrict jsonObjectAgg jsonObjectAggStrict jsonObjectAggUnique jsonObjectAggUniqueStrict left length like likeEscape lower lpad lt lte ltrim max md5 min mode ne normalize notlike numNonnulls numNulls octetLength overlay percentRank pgSizeBytes position quoteIdent quoteLiteral quoteNullable rank regexpCount regexpInstr regexpLike regexpReplace regexpSplitToTable regexpSubstr repeat replace reverse right rpad rtrim similarEscape similarToEscape splitPart startsWith stringAgg stringToTable strpos substr substring textcat texticlike texticnlike texticregexeq texticregexne textLarger textlen textlike textnlike textPatternGe textPatternGt textPatternLe textPatternLt textregexeq textregexne textSmaller timezone toAscii toSql translate unicodeAssigned unistr upper xmlcomment xmlexists xmlIsWellFormedContent xmlIsWellFormedDocument xmltext xpathExists column from serialize

    Constructors

    Properties

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

    Static__typname

    __typname: Raw = ...

    Static__typnameText

    __typnameText: string = "text"

    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

      • M0 extends string | Text<any>
      • M1 extends number | Int4<any>

      Parameters

      Returns Text<StrictNull<N | NullOf<M0> | NullOf<M1>>>

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends number | Int4<any>
      • M2 extends number | Int4<any>

      Parameters

      Returns Text<StrictNull<N | NullOf<M0> | NullOf<M1> | NullOf<M2>>>

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends number | Int4<any>
      • M2 extends number | Int4<any>

      Parameters

      Returns Int4<StrictNull<N | NullOf<M0> | NullOf<M1> | NullOf<M2>>>

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends number | Int4<any>
      • M2 extends number | Int4<any>
      • M3 extends number | Int4<any>
      • M4 extends string | Text<any>
      • M5 extends number | Int4<any>

      Parameters

      Returns Int4<
          StrictNull<
              | N
              | NullOf<M0>
              | NullOf<M1>
              | NullOf<M2>
              | NullOf<M3>
              | NullOf<M4>
              | NullOf<M5>,
          >,
      >

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends number | Int4<any>
      • M2 extends number | Int4<any>
      • M3 extends number | Int4<any>
      • M4 extends string | Text<any>

      Parameters

      Returns Int4<
          StrictNull<
              N
              | NullOf<M0>
              | NullOf<M1>
              | NullOf<M2>
              | NullOf<M3>
              | NullOf<M4>,
          >,
      >

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends number | Int4<any>
      • M2 extends number | Int4<any>
      • M3 extends number | Int4<any>

      Parameters

      Returns Int4<StrictNull<N | NullOf<M0> | NullOf<M1> | NullOf<M2> | NullOf<M3>>>

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends number | Int4<any>

      Parameters

      Returns Int4<StrictNull<N | NullOf<M0> | NullOf<M1>>>

    • Type Parameters

      • M0 extends string | Text<any>

      Parameters

      Returns Int4<StrictNull<N | NullOf<M0>>>

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends string | Text<any>
      • M2 extends number | Int4<any>
      • M3 extends number | Int4<any>

      Parameters

      Returns Text<StrictNull<N | NullOf<M0> | NullOf<M1> | NullOf<M2> | NullOf<M3>>>

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends string | Text<any>
      • M2 extends number | Int4<any>

      Parameters

      Returns Text<StrictNull<N | NullOf<M0> | NullOf<M1> | NullOf<M2>>>

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends string | Text<any>

      Parameters

      Returns Text<StrictNull<N | NullOf<M0> | NullOf<M1>>>

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends string | Text<any>
      • M2 extends string | Text<any>

      Parameters

      Returns Text<StrictNull<N | NullOf<M0> | NullOf<M1> | NullOf<M2>>>

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends string | Text<any>
      • M2 extends number | Int4<any>
      • M3 extends number | Int4<any>
      • M4 extends string | Text<any>

      Parameters

      Returns Text<
          StrictNull<
              N
              | NullOf<M0>
              | NullOf<M1>
              | NullOf<M2>
              | NullOf<M3>
              | NullOf<M4>,
          >,
      >

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends string | Text<any>

      Parameters

      Returns PgSrf<
          { regexp_split_to_table: Text<StrictNull<N | NullOf<M0> | NullOf<M1>>> },
          "regexp_split_to_table",
      >

    • Type Parameters

      • M0 extends string | Text<any>

      Parameters

      Returns PgSrf<
          { regexp_split_to_table: Text<StrictNull<N | NullOf<M0>>> },
          "regexp_split_to_table",
      >

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends number | Int4<any>
      • M2 extends number | Int4<any>
      • M3 extends string | Text<any>
      • M4 extends number | Int4<any>

      Parameters

      Returns Text<
          StrictNull<
              N
              | NullOf<M0>
              | NullOf<M1>
              | NullOf<M2>
              | NullOf<M3>
              | NullOf<M4>,
          >,
      >

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends number | Int4<any>
      • M2 extends number | Int4<any>

      Parameters

      Returns Text<StrictNull<N | NullOf<M0> | NullOf<M1> | NullOf<M2>>>

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends number | Int4<any>

      Parameters

      Returns Text<StrictNull<N | NullOf<M0> | NullOf<M1>>>

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends number | Int4<any>
      • M2 extends number | Int4<any>
      • M3 extends string | Text<any>

      Parameters

      Returns Text<StrictNull<N | NullOf<M0> | NullOf<M1> | NullOf<M2> | NullOf<M3>>>

    • Type Parameters

      • M0 extends string | Text<any>

      Parameters

      Returns Text<StrictNull<N | NullOf<M0>>>

    • Type Parameters

      • M0 extends string | Text<any>

      Parameters

      Returns PgSrf<{ string_to_table: Text<1> }, "string_to_table">

    • Type Parameters

      • M0 extends string | Text<any>
      • M1 extends string | Text<any>

      Parameters

      Returns PgSrf<{ string_to_table: Text<1> }, "string_to_table">

    • 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
    !~!~*!~~!~~*@@^@<<=<>=>>=||~~*~<=~~<~~>=~~>~~~~~*anyValueanyValueTransfnarrayAggarrayPrependasciibitLengthbtrimcastcharcharacterLengthcharLengthcoalescecountcumeDistdatePartdateTruncdecodedenseRankelemContainedByMultirangeelemContainedByRangeeqextractgtgteininitcapisNormalizedisNotNullisNulljsonAggjsonAggStrictjsonbAggjsonbAggStrictjsonbObjectAggjsonbObjectAggStrictjsonbObjectAggUniquejsonbObjectAggUniqueStrictjsonObjectAggjsonObjectAggStrictjsonObjectAggUniquejsonObjectAggUniqueStrictleftlengthlikelikeEscapelowerlpadltlteltrimmaxmd5minmodenenormalizenotlikenumNonnullsnumNullsoctetLengthoverlaypercentRankpgSizeBytespositionquoteIdentquoteLiteralquoteNullablerankregexpCountregexpInstrregexpLikeregexpReplaceregexpSplitToTableregexpSubstrrepeatreplacereverserightrpadrtrimsimilarEscapesimilarToEscapesplitPartstartsWithstringAggstringToTablestrpossubstrsubstringtextcattexticliketexticnliketexticregexeqtexticregexnetextLargertextlentextliketextnliketextPatternGetextPatternGttextPatternLetextPatternLttextregexeqtextregexnetextSmallertimezonetoAsciitoSqltranslateunicodeAssignedunistrupperxmlcommentxmlexistsxmlIsWellFormedContentxmlIsWellFormedDocumentxmltextxpathExistscolumnfromserialize