bundlingUtils.d.ts
1.22 KB
/**
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Provides behavior that supports request bundling.
*/
import { RequestType } from '../apitypes';
/**
* Compute the identifier of the `obj`. The objects of the same ID
* will be bundled together.
*
* @param {RequestType} obj - The request object.
* @param {String[]} discriminatorFields - The array of field names.
* A field name may include '.' as a separator, which is used to
* indicate object traversal.
* @return {String|undefined} - the identifier string, or undefined if any
* discriminator fields do not exist.
*/
export declare function computeBundleId(obj: RequestType, discriminatorFields: string[]): string | undefined;