botbuilder-azure/lib/cosmosDbKeyEscape.d.ts

Azure extensions for Microsoft BotBuilder.

export declare namespace CosmosDbKeyEscape {
    /**
     * Converts the key into a DocumentID that can be used safely with CosmosDB.
     * The following characters are restricted and cannot be used in the Id property: '/', '\', '?', '#'
     * More information at https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.documents.resource.id?view=azure-dotnet#remarks
     *
     * @param key The provided key to be escaped.
     * @param keySuffix The string to add a the end of all RowKeys.
     * @param compatibilityMode True if keys should be truncated in order to support previous CosmosDb
     * max key length of 255.  This behavior can be overridden by setting cosmosDbPartitionedStorageOptions.compatibilityMode to false.
     * @returns An escaped key that can be used safely with CosmosDB.
     */
    function escapeKey(key: string, keySuffix?: string, compatibilityMode?: boolean): string;
}
//# sourceMappingURL=cosmosDbKeyEscape.d.ts.map