EventEmitter
↳ FlatfileImporter
+ new FlatfileImporter(
apiKey
options
customer?
Defined in src/index.ts:36
Parameters:
Name | Type |
---|---|
apiKey | string |
options | object |
customer? | CustomerObject |
Returns: FlatfileImporter
• \$ready: Promise‹any›
Defined in src/index.ts:23
Promise that resolves when the handshake is completed between Flatfile.io and the adapter
Static
▪ Promise: PromiseConstructor = Promise
Defined in src/index.ts:17
Static
▪ prefixed: string | boolean
Inherited from FlatfileImporter.prefixed
Defined in node_modules/eventemitter3/index.d.ts:10
▸ addListener(
event
fn
context?
Inherited from FlatfileImporter.addListener
Defined in node_modules/eventemitter3/index.d.ts:37
Parameters:
Name | Type |
---|---|
event | string | symbol |
fn | ListenerFn |
context? | any |
Returns: this
▸ close(): void
Defined in src/index.ts:229
Call close() from the parent window in order to hide the importer. You can do this after handling the import callback so your users don't have to click the confirmation button
Returns: void
▸ displayError(
msg
Defined in src/index.ts:153
This will display a dialog inside of the importer with an error icon and the message you pass. The user will be able to acknowledge the error and be returned to the import data spreadsheet to ideally fix any issues or attempt submitting again.
deprecated
Parameters:
Name | Type |
---|---|
msg | string |
Returns: void
▸ displayLoader(
msg?
Defined in src/index.ts:141
This will display a progress indicator inside the importer if you anticipate that handling the output of the importer may take some time.
Parameters:
Name | Type |
---|---|
msg? | undefined | string |
Returns: void
▸ displaySuccess(
msg
Defined in src/index.ts:175
This will display a dialog inside of the importer with a success icon and the message you pass.
Parameters:
Name | Type |
---|---|
msg | string |
Returns: void
▸ emit(
event
args
Inherited from FlatfileImporter.emit
Defined in node_modules/eventemitter3/index.d.ts:31
Calls each of the listeners registered for a given event.
Parameters:
Name | Type |
---|---|
event | string | symbol |
...args | Array‹any› |
Returns: boolean
▸ eventNames(): Array‹string | symbol›
Inherited from FlatfileImporter.eventNames
Defined in node_modules/eventemitter3/index.d.ts:16
Return an array listing the events for which the emitter has registered listeners.
Returns: Array‹string | symbol›
▸ getMeta(): object
Defined in src/index.ts:184
This will fetch the data from the importer
Returns: object
▸ listenerCount(
event
Inherited from FlatfileImporter.listenerCount
Defined in node_modules/eventemitter3/index.d.ts:26
Return the number of listeners listening to a given event.
Parameters:
Name | Type |
---|---|
event | string | symbol |
Returns: number
▸ listeners(
event
Inherited from FlatfileImporter.listeners
Defined in node_modules/eventemitter3/index.d.ts:21
Return the listeners registered for a given event.
Parameters:
Name | Type |
---|---|
event | string | symbol |
Returns: Array‹ListenerFn›
▸ load(): Promise‹Array‹Object››
Defined in src/index.ts:104
Use load() when you want a promise returned. This is necessary if you want to use async/await for an es6 implementation
deprecated
Returns: Promise‹Array‹Object››
▸ off(
event
fn?
context?
once?
Inherited from FlatfileImporter.off
Defined in node_modules/eventemitter3/index.d.ts:48
Parameters:
Name | Type |
---|---|
event | string | symbol |
fn? | ListenerFn |
context? | any |
once? | undefined | false | true |
Returns: this
▸ on(
event
fn
context?
Inherited from FlatfileImporter.on
Defined in node_modules/eventemitter3/index.d.ts:36
Add a listener for a given event.
Parameters:
Name | Type |
---|---|
event | string | symbol |
fn | ListenerFn |
context? | any |
Returns: this
▸ once(
event
fn
context?
Inherited from FlatfileImporter.once
Defined in node_modules/eventemitter3/index.d.ts:42
Add a one-time listener for a given event.
Parameters:
Name | Type |
---|---|
event | string | symbol |
fn | ListenerFn |
context? | any |
Returns: this
▸ open(
options
Defined in src/index.ts:82
Call open() to activate the importer overlay dialog.
Parameters:
Name | Type | Default |
---|---|---|
options | object | {} |
Returns: void
▸ registerFieldHook(
field
cb
Defined in src/index.ts:221
Set the customer information for this import
Parameters:
Name | Type |
---|---|
field | string |
cb | FieldHookCallback |
Returns: void
▸ registerRecordHook(
callback
Defined in src/index.ts:214
Set the customer information for this import
Parameters:
Name | Type |
---|---|
callback | FlatfileImporter["$recordHook"] |
Returns: void
▸ registerValidatorCallback(
callback
Defined in src/index.ts:204
Set the customer information for this import
Parameters:
Name | Type |
---|---|
callback | FlatfileImporter["$validatorCallback"] |
Returns: void
▸ removeAllListeners(
event?
Inherited from FlatfileImporter.removeAllListeners
Defined in node_modules/eventemitter3/index.d.ts:53
Remove all listeners, or those of the specified event.
Parameters:
Name | Type |
---|---|
event? | string | symbol |
Returns: this
▸ removeListener(
event
fn?
context?
once?
Inherited from FlatfileImporter.removeListener
Defined in node_modules/eventemitter3/index.d.ts:47
Remove the listeners of a given event.
Parameters:
Name | Type |
---|---|
event | string | symbol |
fn? | ListenerFn |
context? | any |
once? | undefined | false | true |
Returns: this
▸ requestCorrectionsFromUser(
msg
Defined in src/index.ts:164
This will display a dialog inside of the importer with an error icon and the message you pass. The user will be able to acknowledge the error and be returned to the import data spreadsheet to ideally fix any issues or attempt submitting again.
Parameters:
Name | Type |
---|---|
msg | any |
Returns: Promise‹FlatfileResults›
▸ requestDataFromUser(
options
Defined in src/index.ts:132
Use requestDataFromUser() when you want a promise returned. This is necessary if you want to use async/await for an es6 implementation
Parameters:
Name | Type | Default |
---|---|---|
options | LoadOptionsObject | {} |
Returns: Promise‹FlatfileResults›
▸ setCustomer(
customer
Defined in src/index.ts:197
Set the customer information for this import
Parameters:
Name | Type |
---|---|
customer | CustomerObject |
Returns: void
Static
▸ setMountUrl(
url
Defined in src/index.ts:59
This will by default always be
https://www.flatfile.io/importer/:key
Parameters:
Name | Type |
---|---|
url | string |
Returns: void
Static
▸ setVersion(
version
Defined in src/index.ts:66
This allows you to opt into or out of specific versions of the Flatfile SDK
Parameters:
Name | Type |
---|---|
version | 1 | 2 |
Returns: void