saveDatasetDescriptor
saveDatasetDescriptor(
dataset,options):Promise<void>
Defined in: metadata/actions/dataset/save.ts:11
Save a Dataset to a file path Works in Node.js environments
Parameters
Section titled “Parameters”dataset
Section titled “dataset”$schema?
Section titled “$schema?”string = ...
alternateIdentifiers?
Section titled “alternateIdentifiers?”object[] = ...
contributors?
Section titled “contributors?”object[] = ...
creators?
Section titled “creators?”object[] = ...
dates?
Section titled “dates?”object[] = ...
descriptions?
Section titled “descriptions?”object[] = ...
string = ...
formats?
Section titled “formats?”string[] = ...
fundingReferences?
Section titled “fundingReferences?”object[] = ...
geoLocations?
Section titled “geoLocations?”object[] = ...
language?
Section titled “language?”string = ...
prefix?
Section titled “prefix?”string = ...
publicationYear?
Section titled “publicationYear?”string = ...
publisher?
Section titled “publisher?”{ lang?: string; name: string; publisherIdentifier?: string; publisherIdentifierScheme?: string; schemeUri?: string; } = ...
publisher.lang?
Section titled “publisher.lang?”string = ...
publisher.name
Section titled “publisher.name”string = ...
publisher.publisherIdentifier?
Section titled “publisher.publisherIdentifier?”string = ...
publisher.publisherIdentifierScheme?
Section titled “publisher.publisherIdentifierScheme?”string = ...
publisher.schemeUri?
Section titled “publisher.schemeUri?”string = ...
relatedIdentifiers?
Section titled “relatedIdentifiers?”object[] = ...
relatedItems?
Section titled “relatedItems?”object[] = ...
resources?
Section titled “resources?”object[] = ...
rightsList?
Section titled “rightsList?”object[] = ...
sizes?
Section titled “sizes?”string[] = ...
subjects?
Section titled “subjects?”object[] = ...
suffix?
Section titled “suffix?”string = ...
titles?
Section titled “titles?”object[] = ...
types?
Section titled “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"; } = ...
types.resourceType?
Section titled “types.resourceType?”string = ...
types.resourceTypeGeneral
Section titled “types.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?
Section titled “version?”string = ...
options
Section titled “options”overwrite?
Section titled “overwrite?”boolean
string
Returns
Section titled “Returns”Promise<void>