ibm-vpc
Version:
IBM Cloud VPC Node.js SDK
38 lines (37 loc) • 1.58 kB
TypeScript
/**
* (C) Copyright IBM Corp. 2023, 2024, 2025.
*
* 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.
*/
export type SdkHeaders = {
'X-Request-Id': string;
'User-Agent': string;
};
/**
* Get the request headers to be sent in requests by the SDK.
*
* If you plan to gather metrics for your SDK, the User-Agent header value must
* be a string similar to the following:
* vpc-node-sdk/0.0.1 (lang=node.js; os.name=Linux; os.version=19.3.0; node.version=v10.15.3)
*
* In the example above, the analytics tool will parse the user-agent header and
* use the following properties:
* "vpc-node-sdk" - the name of your sdk
* "0.0.1"- the version of your sdk
* "lang=node.js" - the language of the current sdk
* "os.name=Linux; os.version=19.3.0; node.version=v10.15.3" - system information
*
* Note: It is very important that the sdk name ends with the string `-sdk`,
* as the analytics data collector uses this to gather usage data.
*/
export declare function getSdkHeaders(serviceName: string, serviceVersion: string, operationId: string): SdkHeaders | {};