Poniżej znajduje się przegląd specyfikacji interfejsu API Bundle Builder, w tym definicje TypeScript i szczegółowe opisy.
Interfejs pakietuDocument
Specyfikacja pojedynczego dokumentu w skonfigurowanej kolekcji:
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;
};
Interfejs definicji parametru
Specyfikacja pojedynczego parametru zdefiniowanego w 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";
};
Na przykład, biorąc pod uwagę następujący parametr:
params: {
name: {
required: true,
type: 'string',
}
}
Podczas wysyłania żądania do punktu końcowego HTTP pakietu parametr można podać poprzez parametr zapytania, np ?name=david
. Parametru można użyć w wartości QueryDefinition
(patrz poniżej) ( $name
), aby dynamicznie tworzyć pakiety.
Interfejs definicji zapytania
Definicja zapytania służy do tworzenia nazwanych zapytań w pakiecie. Każdy obiekt na mapie queries
utworzy nowe nazwane zapytanie, używając klucza obiektu jako nazwy. Każde zapytanie musi określać kolekcję i opcjonalnie listę warunków zapytania do wykonania.
type QueryDefinition = {
// The collection to perform the query on.
collection: string;
// An optional list of conditions to perform on the specified collection.
conditions?: QueryCondition[];
};
Parametr conditions
może zawierać tablicę interfejsów QueryCondition
. Każdy element tablicy może zawierać tylko jeden warunek.
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;
};
Na przykład, aby utworzyć zapytanie o nazwie „produkty” dotyczące kolekcji products
z warunkiem miejsca i limitu, dane wyjściowe struktury danych powinny być zgodne z poniższym:
queries: {
products: {
collection: 'products',
conditions: [
{ where: ['type', '==', 'featured'] },
{ limit: 10 },
],
}
}
Podając wartości tablicowe do filtrów in
, not-in
lub array-contains-any
, musisz podać wartość oddzieloną przecinkami, ponieważ wartości zagnieżdżone nie są obsługiwane w Firestore. Na przykład:
{ where: ['category', 'in', 'womens,shorts'] }, // ['womens', 'shorts']
Każda wartość liczbowa zostanie przeanalizowana jako liczba, jednak jeśli wymagana jest wartość liczbowa w postaci ciągu znaków, należy ją ująć w nawiasy:
{ where: ['price', 'in', '1,2.5'] }, // [1, 2.5]
{ where: ['price', 'in', '"1","2.5"'] }, // ['1', '2.5']
Warunki mogą być również używane razem z parametrami. Na przykład, jeśli zdefiniowany jest type
parametru (patrz wyżej), można go podać do wartości warunku, aby zapewnić dynamiczne pakiety danych za pomocą składni $
:
// ?type=featured
conditions: [
{ where: ['type', '==', '$type'] },