bigbuffet-rw/packages/pl-api/lib/entities/admin/measure.ts
marcin mikołajczak b357261ff2 pl-api: Update docs
Signed-off-by: marcin mikołajczak <git@mkljczk.pl>
2024-11-29 15:52:33 +01:00

29 lines
764 B
TypeScript

import * as v from 'valibot';
import { datetimeSchema } from '../utils';
/**
* @category Admin schemas
* @see {@link https://docs.joinmastodon.org/entities/Admin_Measure/}
*/
const adminMeasureSchema = v.object({
key: v.string(),
unit: v.fallback(v.nullable(v.string()), null),
total: v.pipe(v.unknown(), v.transform(Number)),
human_value: v.fallback(v.optional(v.string()), undefined),
previous_total: v.fallback(v.optional(v.pipe(v.unknown(), v.transform(String))), undefined),
data: v.array(v.object({
date: datetimeSchema,
value: v.pipe(v.unknown(), v.transform(String)),
})),
});
/**
* @category Admin types
*/
type AdminMeasure = v.InferOutput<typeof adminMeasureSchema>;
export {
adminMeasureSchema,
type AdminMeasure,
};