Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

CosmosEncryptedNumber interface

Package:
@azure/cosmos

This interface represents an encrypted number in the Cosmos DB SDK.

Example

import { CosmosEncryptedNumber, CosmosEncryptedNumberType } from "@azure/cosmos";

const encryptedNumber1: CosmosEncryptedNumber = {
 value: 4,
 numberType: CosmosEncryptedNumberType.Integer,
};
const encryptedNumber2: CosmosEncryptedNumber = {
 value: 4.1,
 numberType: CosmosEncryptedNumberType.Float,
};
const encryptedNumber3: CosmosEncryptedNumber = {
 value: 4,
 numberType: CosmosEncryptedNumberType.Float, // represents 4.0
};

Properties

numberType

The type of number (Integer or Float). Use CosmosEncryptedNumberType.Integer for integers and CosmosEncryptedNumberType.Float for floating-point numbers.
value

The value to be encrypted.

Property Details

numberType

The type of number (Integer or Float). Use CosmosEncryptedNumberType.Integer for integers and CosmosEncryptedNumberType.Float for floating-point numbers.

numberType: CosmosEncryptedNumberType

Property Value

value

The value to be encrypted.

value: number

Property Value

number