assertDataset
assertDataset(
source,options?):Promise<{$schema?:string;alternateIdentifiers?:object[];contributors?:object[];creators?:object[];dates?:object[];descriptions?:object[];doi?:string;formats?:string[];fundingReferences?:object[];geoLocations?:object[];language?:string;prefix?:string;publicationYear?:string;publisher?: {lang?:string;name:string;publisherIdentifier?:string;publisherIdentifierScheme?:string;schemeUri?:string; };relatedIdentifiers?:object[];relatedItems?:object[];resources?:object[];rightsList?:object[];sizes?:string[];subjects?:object[];suffix?:string;titles?:object[];types?: {resourceType?:string;resourceTypeGeneral:"Other"|"Audiovisual"|"Award"|"Book"|"BookChapter"|"Collection"|"ComputationalNotebook"|"ConferencePaper"|"ConferenceProceeding"|"DataPaper"|"Dataset"|"Dissertation"|"Event"|"Image"|"Instrument"|"InteractiveResource"|"Journal"|"JournalArticle"|"Model"|"OutputManagementPlan"|"PeerReview"|"PhysicalObject"|"Preprint"|"Project"|"Report"|"Service"|"Software"|"Sound"|"Standard"|"StudyRegistration"|"Text"|"Workflow"; };version?:string; }>
Defined in: metadata/actions/dataset/assert.ts:8
Assert a Dataset descriptor (JSON Object) against its profile
Parameters
Section titled “Parameters”source
Section titled “source”Record<string, unknown> | { $schema?: string; alternateIdentifiers?: object[]; contributors?: object[]; creators?: object[]; dates?: object[]; descriptions?: object[]; doi?: string; formats?: string[]; fundingReferences?: object[]; geoLocations?: object[]; language?: string; prefix?: string; publicationYear?: string; publisher?: { lang?: string; name: string; publisherIdentifier?: string; publisherIdentifierScheme?: string; schemeUri?: string; }; relatedIdentifiers?: object[]; relatedItems?: object[]; resources?: object[]; rightsList?: object[]; sizes?: string[]; subjects?: object[]; suffix?: string; titles?: object[]; types?: { resourceType?: string; resourceTypeGeneral: "Other" | "Audiovisual" | "Award" | "Book" | "BookChapter" | "Collection" | "ComputationalNotebook" | "ConferencePaper" | "ConferenceProceeding" | "DataPaper" | "Dataset" | "Dissertation" | "Event" | "Image" | "Instrument" | "InteractiveResource" | "Journal" | "JournalArticle" | "Model" | "OutputManagementPlan" | "PeerReview" | "PhysicalObject" | "Preprint" | "Project" | "Report" | "Service" | "Software" | "Sound" | "Standard" | "StudyRegistration" | "Text" | "Workflow"; }; version?: string; }
options?
Section titled “options?”basepath?
Section titled “basepath?”string
Returns
Section titled “Returns”Promise<{ $schema?: string; alternateIdentifiers?: object[]; contributors?: object[]; creators?: object[]; dates?: object[]; descriptions?: object[]; doi?: string; formats?: string[]; fundingReferences?: object[]; geoLocations?: object[]; language?: string; prefix?: string; publicationYear?: string; publisher?: { lang?: string; name: string; publisherIdentifier?: string; publisherIdentifierScheme?: string; schemeUri?: string; }; relatedIdentifiers?: object[]; relatedItems?: object[]; resources?: object[]; rightsList?: object[]; sizes?: string[]; subjects?: object[]; suffix?: string; titles?: object[]; types?: { resourceType?: string; resourceTypeGeneral: "Other" | "Audiovisual" | "Award" | "Book" | "BookChapter" | "Collection" | "ComputationalNotebook" | "ConferencePaper" | "ConferenceProceeding" | "DataPaper" | "Dataset" | "Dissertation" | "Event" | "Image" | "Instrument" | "InteractiveResource" | "Journal" | "JournalArticle" | "Model" | "OutputManagementPlan" | "PeerReview" | "PhysicalObject" | "Preprint" | "Project" | "Report" | "Service" | "Software" | "Sound" | "Standard" | "StudyRegistration" | "Text" | "Workflow"; }; version?: string; }>