useEgressQuota

function useEgressQuota(props): UseQueryResult<DataSetStats, Error>;

Defined in: synapse-react/src/warm-storage/use-egress-quota.ts:36

Get the egress quota for a data set from FilBeam.

Parameters

Parameter	Type	Description
props	UseEgressQuotaProps	The props to use.

Returns

UseQueryResult<DataSetStats, Error>

The egress quota for the data set.

Example

const { data: egressQuota, isLoading } = useEgressQuota({ dataSetId: 123n })
if (egressQuota) {
  console.log(`CDN Egress: ${egressQuota.cdnEgressQuota}`)
  console.log(`Cache Miss Egress: ${egressQuota.cacheMissEgressQuota}`)
}