@snailicide/build-config / npm / isNPMPackage

isNPMPackage()

function isNPMPackage<Schema, BaseSchema>(
   value, 
   custom_schema, 
   show_error, 
passthru): value is undefined | PackageJson<Schema, BaseSchema>;

Defined in: packages/build-config/src/npm/npm.package.ts:51

Validates a npm package.json object

Type Parameters

Type Parameter	Default type
Schema extends AnyZodObject	-
BaseSchema extends AnyZodObject	ZodObject<{ author: ZodObject<{ email: ZodString; name: ZodString; }, "strip", ZodTypeAny, { email: string; name: string; }, { email: string; name: string; }>; description: ZodString; license: ZodString; main: ZodString; name: ZodString; repository: ZodObject<{ type: ZodString; url: ZodString; }, "strip", ZodTypeAny, { type: string; url: string; }, { type: string; url: string; }>; version: ZodEffects<ZodString, string, string>; }, "strip", ZodTypeAny, { author: { email: string; name: string; }; description: string; license: string; main: string; name: string; repository: { type: string; url: string; }; version: string; }, { author: { email: string; name: string; }; description: string; license: string; main: string; name: string; repository: { type: string; url: string; }; version: string; }>

Parameters

Parameter	Type	Default value
value	unknown	undefined
custom_schema	undefined | Schema	undefined
show_error	boolean | "safe"	false
passthru	boolean	true

Returns

value is undefined | PackageJson<Schema, BaseSchema>