एपीआई का संदर्भ

यहां बंडल बिल्डर एपीआई की खास बातों के बारे में खास जानकारी दी गई है. इसमें TypeScript की परिभाषाएं और ज़्यादा जानकारी शामिल है.

BundleDocument इंटरफ़ेस

कॉन्फ़िगर किए गए कलेक्शन में मौजूद किसी एक दस्तावेज़ की खास बातें:

type BundleDocument = {
  // A list of document IDs to serve in the bundle.
  docs?: Array<string>;
  // A map containing individual named queries and their definitions.
  queries?: Map<string, QueryDefinition[]>;
  // A map of parameters and their definitions, which can be provided to a query definition.
  params?: Map<string, ParamDefinition>;
  // Specifies how long to keep the bundle in the client's cache, in seconds. If not defined, client-side cache is disabled.
  clientCache?: string;
  // Only used in combination with Firebase Hosting. Specifies how long to keep the bundle in Firebase Hosting CDN cache, in seconds.
  serverCache: string;
  // Specifies how long (in seconds) to keep the bundle in a Cloud Storage bucket, in seconds. If not defined, Cloud Storage bucket is not accessed.
  fileCache?: string;
  // If a 'File Cache' is specified, bundles created before this timestamp will not be file cached.
  notBefore?: Timestamp;
};

ParamDefinition इंटरफ़ेस

BundleDocument में तय किए गए किसी एक पैरामीटर की जानकारी.

type ParamDefinition = {
  // Whether this parameter is required. If not provided as a query string, an error will be thrown.
  required: boolean;
  // The type of value which will be parsed, defaults to 'string'.
  type?:
    | "string"
    | "integer"
    | "float"
    | "boolean"
    | "string-array"
    | "integer-array"
    | "float-array";
};

उदाहरण के लिए, यह पैरामीटर:

params: {
  name: {
    required: true,
    type: 'string',
  }
}

बंडल एचटीटीपी एंडपॉइंट का अनुरोध करते समय, पैरामीटर को क्वेरी पैरामीटर के ज़रिए दिया जा सकता है, जैसे कि ?name=david. डाइनैमिक तौर पर बंडल बनाने के लिए, पैरामीटर का इस्तेमाल QueryDefinition (नीचे देखें) वैल्यू ($name) में किया जा सकता है.

QueryDefinition इंटरफ़ेस

क्वेरी की परिभाषा का इस्तेमाल, बंडल पर नाम वाली क्वेरी बनाने के लिए किया जाता है. queries मैप में मौजूद हर ऑब्जेक्ट, नाम वाली एक नई क्वेरी बनाएगा. इसके लिए, ऑब्जेक्ट की कुंजी का इस्तेमाल नाम के तौर पर किया जाएगा. हर क्वेरी में एक कलेक्शन होना चाहिए. इसके अलावा, क्वेरी की शर्तों की सूची भी हो सकती है.

type QueryDefinition = {
  // The collection to perform the query on.
  collection: string;
  // An optional list of conditions to perform on the specified collection.
  conditions?: QueryCondition[];
};

conditions पैरामीटर में QueryCondition इंटरफ़ेस का कलेक्शन हो सकता है. कलेक्शन में मौजूद हर आइटम में सिर्फ़ एक शर्त शामिल होनी चाहिए.

type QueryCondition = {
  // Performs a `where` filter on the collection on a given FieldPath, operator and value.
  where?: [
    string,
    (
      | "<"
      | "<="
      | "=="
      | ">="
      | ">"
      | "!="
      | "array-contains"
      | "in"
      | "not-in"
      | "array-contains-any"
    ),
    any
  ];
  orderBy?: [string, ("asc" | "desc")?];
  limit?: number;
  limitToLast?: number;
  offset?: number;
  startAt?: string;
  startAfter?: string;
  endAt?: string;
  endBefore?: string;
};

उदाहरण के लिए, products कलेक्शन में "प्रॉडक्ट" नाम की क्वेरी बनाने के लिए, जहां और सीमित की शर्त का इस्तेमाल करें. इसके लिए, डेटा स्ट्रक्चर का आउटपुट इनके साथ मैच करना चाहिए:

queries: {
  products: {
    collection: 'products',
    conditions: [
      { where: ['type', '==', 'featured'] },
      { limit: 10 },
    ],
  }
}

in, not-in या array-contains-any फ़िल्टर में अरे वैल्यू देते समय, आपको कॉमा लगाकर अलग की गई वैल्यू देनी होगी. ऐसा इसलिए, क्योंकि Firestore में नेस्ट की गई अरे वैल्यू काम नहीं करतीं. उदाहरण के लिए:

{ where: ['category', 'in', 'womens,shorts'] }, // ['womens', 'shorts']

किसी भी संख्या की वैल्यू को संख्या के तौर पर पार्स किया जाएगा. हालांकि, अगर संख्या की स्ट्रिंग वैल्यू की ज़रूरत है, तो उसे ब्रैकेट में लपेटा जाना चाहिए:

{ where: ['price', 'in', '1,2.5'] }, // [1, 2.5]
{ where: ['price', 'in', '"1","2.5"'] }, // ['1', '2.5']

पैरामीटर के साथ-साथ शर्तों का इस्तेमाल भी किया जा सकता है. उदाहरण के लिए, अगर कोई पैरामीटर type तय किया गया है (ऊपर देखें), तो $ सिंटैक्स की मदद से डाइनैमिक डेटा बंडल देने के लिए, इसे शर्त की वैल्यू के तौर पर दिया जा सकता है:

// ?type=featured


    conditions: [
      { where: ['type', '==', '$type'] },