Skip to content

@sqlrooms/project-builder / isSpatialLoadFileOptions

Function: isSpatialLoadFileOptions()

isSpatialLoadFileOptions(options): options is objectOutputType<extendShape<extendShape<{ schema: ZodOptional<ZodString>; select: ZodOptional<ZodArray<ZodString, "many">>; where: ZodOptional<ZodString>; view: ZodOptional<ZodBoolean>; temp: ZodOptional<ZodBoolean>; replace: ZodOptional<ZodBoolean> }, { options: ZodOptional<ZodUnion<[ZodArray<ZodString, "many">, ZodString, ZodRecord<ZodString, ZodUnknown>]>> }>, { method: ZodLiteral<"st_read"> }>, ZodUnknown, "strip">

Type guard to check if options are spatial load file options

Parameters

ParameterTypeDescription
optionsobjectOutputType<extendShape<{ schema: ZodOptional<ZodString>; select: ZodOptional<ZodArray<ZodString, "many">>; where: ZodOptional<ZodString>; view: ZodOptional<ZodBoolean>; temp: ZodOptional<ZodBoolean>; replace: ZodOptional<ZodBoolean>; }, { method: ZodEnum<["read_json", "read_ndjson", "read_parquet", "read_csv", "auto"]>; }>, ZodUnknown, "strip"> | objectOutputType<extendShape<extendShape<{ schema: ZodOptional<ZodString>; select: ZodOptional<ZodArray<ZodString, "many">>; where: ZodOptional<ZodString>; view: ZodOptional<ZodBoolean>; temp: ZodOptional<ZodBoolean>; replace: ZodOptional<ZodBoolean>; }, { options: ZodOptional<ZodUnion<[ZodArray<ZodString, "many">, ZodString, ZodRecord<ZodString, ZodUnknown>]>>; }>, { method: ZodLiteral<"st_read">; }>, ZodUnknown, "strip">The options to check

Returns

options is objectOutputType<extendShape<extendShape<{ schema: ZodOptional<ZodString>; select: ZodOptional<ZodArray<ZodString, "many">>; where: ZodOptional<ZodString>; view: ZodOptional<ZodBoolean>; temp: ZodOptional<ZodBoolean>; replace: ZodOptional<ZodBoolean> }, { options: ZodOptional<ZodUnion<[ZodArray<ZodString, "many">, ZodString, ZodRecord<ZodString, ZodUnknown>]>> }>, { method: ZodLiteral<"st_read"> }>, ZodUnknown, "strip">

True if options are spatial load file options