length to strLength

googleapis · Sep 11, 2024 · 0f4066c · 0f4066c
1 parent 38b3981
commit 0f4066c
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 17 deletions.
diff --git a/dev/src/expression.ts b/dev/src/expression.ts
@@ -671,13 +671,13 @@ export abstract class Expr implements firestore.Expr {
    *
    * ```typescript
    * // Get the length of the 'name' field
-   * Field.of("name").length();
+   * Field.of("name").strLength();
    * ```
    *
    * @return A new `Expr` representing the length of the string.
    */
-  length(): Length {
-    return new Length(this);
+  strLength(): StrLength {
+    return new StrLength(this);
   }
 
   /**
@@ -1857,7 +1857,7 @@ class If extends Function implements FilterCondition {
 /**
  * @beta
  */
-class Length extends Function {
+class StrLength extends Function {
   constructor(private expr: Expr) {
     super('length', [expr]);
   }
@@ -3492,13 +3492,13 @@ export function isNan(value: Expr | string): IsNan {
  *
  * ```typescript
  * // Get the length of the 'name' field
- * length("name");
+ * strLength("name");
  * ```
  *
  * @param field The name of the field containing the string.
  * @return A new {@code Expr} representing the length of the string.
  */
-export function length(field: string): Length;
+export function strLength(field: string): StrLength;
 
 /**
  * @beta
@@ -3507,16 +3507,16 @@ export function length(field: string): Length;
  *
  * ```typescript
  * // Get the length of the 'name' field
- * length(Field.of("name"));
+ * strLength(Field.of("name"));
  * ```
  *
  * @param expr The expression representing the string to calculate the length of.
  * @return A new {@code Expr} representing the length of the string.
  */
-export function length(expr: Expr): Length;
-export function length(value: Expr | string): Length {
+export function strLength(expr: Expr): StrLength;
+export function strLength(value: Expr | string): StrLength {
   const valueExpr = value instanceof Expr ? value : Field.of(value);
-  return new Length(valueExpr);
+  return new StrLength(valueExpr);
 }
 
 /**

diff --git a/dev/src/index.ts b/dev/src/index.ts
@@ -168,6 +168,7 @@ export {
   not,
   exists,
   isNan,
+  strLength,
   like,
   regexContains,
   regexMatch,

diff --git a/types/firestore.d.ts b/types/firestore.d.ts
@@ -3744,12 +3744,12 @@ declare namespace FirebaseFirestore {
      *
      * ```typescript
      * // Get the length of the 'name' field
-     * Field.of("name").length();
+     * Field.of("name").strLength();
      * ```
      *
      * @return A new `Expr` representing the length of the string.
      */
-    length(): Length;
+    strLength(): StrLength;
 
     /**
      * Creates an expression that performs a case-sensitive string comparison.
@@ -4569,7 +4569,7 @@ declare namespace FirebaseFirestore {
   /**
    * @beta
    */
-  export class Length extends Function {}
+  export class StrLength extends Function {}
 
   /**
    * @beta
@@ -5979,13 +5979,13 @@ declare namespace FirebaseFirestore {
    *
    * ```typescript
    * // Get the length of the 'name' field
-   * length("name");
+   * strLength("name");
    * ```
    *
    * @param field The name of the field containing the string.
    * @return A new {@code Expr} representing the length of the string.
    */
-  export function length(field: string): Length;
+  export function strLength(field: string): StrLength;
 
   /**
    * @beta
@@ -5994,13 +5994,13 @@ declare namespace FirebaseFirestore {
    *
    * ```typescript
    * // Get the length of the 'name' field
-   * length(Field.of("name"));
+   * strLength(Field.of("name"));
    * ```
    *
    * @param expr The expression representing the string to calculate the length of.
    * @return A new {@code Expr} representing the length of the string.
    */
-  export function length(expr: Expr): Length;
+  export function length(expr: Expr): StrLength;
 
   /**
    * @beta