Easily embed our CSV importer within your app.
The Basics Install Usage Template Schema Transform Mutate Mutate record Batch mutate records Validate Error Warn TEXT EMAIL CHOICE BOOLEAN NUMBER DATETIME There are two ways to integrate an importer. You can load an importer by using a template key corresponding to a pre-made template created in builder , or by utilizing a schema key and manually coding out custom column headers with rules and validations for your importer.
View Schema Demo
npm:
npm i @mightymerge/client --save
browser:
<script src= "https://unpkg.com/@mightymerge/client/dist/mightymerge-client.min.js" ></script>
import mightymergeClient from ' @mightymerge/client '
var importer = mightymergeClient ({
templateKey : ' TEMPLATE_KEY ' ,
})
importer . open ({
chunk : function ( chunk ) {
for ( var i = 0 ; i < chunk . records . length ; i ++ ) {
if ( chunk . records [ i ]. valid == true ) {
// do something with valid record
}
}
},
complete : function () {
// do something on complete
},
})
import mightymergeClient from ' @mightymerge/client '
var importer = mightymergeClient ({
schemaKey : ' SCHEMA_KEY ' ,
})
importer . open ({
schema : {
headers : [
{
text : {
label : ' name ' ,
display : ' Name ' ,
maxLength : 55 ,
required : true ,
},
},
// ...etc
],
},
chunk : function ( chunk ) {
for ( var i = 0 ; i < chunk . records . length ; i ++ ) {
if ( chunk . records [ i ]. valid == true ) {
// do something with valid record
}
}
},
complete : function () {
// do something on complete
},
})
importer . open ({
...
mutateRecord : function ( record ) {
record . data [ " fullname " ] = ` ${ record . data [ " first " ]} ${ record . data [ " last " ]} `
return record
},
})
importer . open ({
...
chunkSize : 1000 , // Default: 100; Max: 1000
mutate : function ( chunk ) {
return chunk . records . map ( record => {
record . data [ " fullname " ] = ` ${ record . data [ " first " ]} ${ record . data [ " last " ]} `
})
},
})
importer . open ({
...
mutateRecord : function ( record ) {
if ( record . data [ " last " ] == '' ) {
record . error [ " last " ] = " Last name is required "
}
return record
},
})
importer . open ({
...
mutateRecord : function ( record ) {
if ( record . data [ " last " ] == '' ) {
record . warn [ " last " ] = " Missing last name "
}
return record
},
...
})
{
// Accepts any text input
text: { ... }
}
Name Value Default Description label string null header label of final output display string (same as label) Display to user description string null Adds a description tipsy to the header column maxLength number null Max length of input minLength number null Min length of input required boolean false Is field required regex object {} Validate on regex {match: "/example/i", message: "Value must include 'example'"}
{
// Validates against email format
email: { ... }
}
Name Value Default Description label string null header label of final output display string (same as label) Display to user description string null Adds a description tipsy to the header column maxLength number null Max length of input minLength number null Min length of input required boolean false Is field required regex object {} Validate on regex {match: "/example/i", message: "Value must include 'example'"}
{
// Validates against exclusive value options
choice: { ... }
}
Name Value Default Description label string null Key header label of final output display string (same as label) Display to user description string null Adds a description tipsy to the header column values array [] List of available options required boolean false Is field required
{
// Validates against having a proper boolean value
boolean: { ... }
}
Name Value Default Description label string null header label of final output display string (same as label) Display to user description string null Adds a description tipsy to the header column trueOutput string ‘TRUE’ Output when input value is true falseOutput string ‘FALSE’ Output when input value is false required boolean false Is field required
{
// Validates against having correct number value
number: { ... }
}
Name Value Default Description label string null header label of final output display string (same as label) Display to user description string null Adds a description tipsy to the header column maxValue number null Max number value of input minValue number null Min number value of input required boolean false Is field required
{
// Validates against having a valid datetime
datetime: { ... }
}
Name Value Default Description label string null Header label of final output display string (same as label) Display to user description string null Adds a description tipsy to the header column format string ‘YYYY-MM-DD HH:mm:ss a’ Auto formats date output required boolean false Is field required