Skip to content
This repository was archived by the owner on Sep 18, 2024. It is now read-only.

api.md

Latest commit

 

History

History
391 lines (274 loc) · 12.1 KB

api.md

File metadata and controls

391 lines (274 loc) · 12.1 KB

Modules

about

AboutApp module

config
Dedupe This!
form
hooks
settings
util
init

about

AboutApp module

about~AboutApp ⇐ FormApplication

About this module FormApp

Kind: inner class of about
Extends: FormApplication

aboutApp.getData()

Supplies data to the template

Kind: instance method of AboutApp

aboutApp.fetchPatrons()

Fetches a list of Patrons to display on the About page

Kind: instance method of AboutApp

AboutApp.defaultOptions

Call app default options

Kind: static property of AboutApp

config

Dedupe This!

  • [Dedupe This!](#module_Dedupe This!)
    • [~DedupeThis](#module_Dedupe This!..DedupeThis)
      • [new DedupeThis()](#new_module_Dedupe This!..DedupeThis_new)
      • [.getFolder(nameOrId)](#module_Dedupe This!..DedupeThis+getFolder)
      • [.getEntities()](#module_Dedupe This!..DedupeThis+getEntities)
      • [.dedupe(folder, criteria)](#module_Dedupe This!..DedupeThis+dedupe)
      • [.getDuplicateFolder(entityType)](#module_Dedupe This!..DedupeThis+getDuplicateFolder)
      • [.createDuplicatesFolder(entityType)](#module_Dedupe This!..DedupeThis+createDuplicatesFolder)
      • [.moveEntities(entities, folder)](#module_Dedupe This!..DedupeThis+moveEntities)

Dedupe This!~DedupeThis

Main worker class

Kind: inner class of [Dedupe This!](#module_Dedupe This!)

  • [~DedupeThis](#module_Dedupe This!..DedupeThis)
    • [new DedupeThis()](#new_module_Dedupe This!..DedupeThis_new)
    • [.getFolder(nameOrId)](#module_Dedupe This!..DedupeThis+getFolder)
    • [.getEntities()](#module_Dedupe This!..DedupeThis+getEntities)
    • [.dedupe(folder, criteria)](#module_Dedupe This!..DedupeThis+dedupe)
    • [.getDuplicateFolder(entityType)](#module_Dedupe This!..DedupeThis+getDuplicateFolder)
    • [.createDuplicatesFolder(entityType)](#module_Dedupe This!..DedupeThis+createDuplicatesFolder)
    • [.moveEntities(entities, folder)](#module_Dedupe This!..DedupeThis+moveEntities)

new DedupeThis()

Instantiate a dedupe worker

dedupeThis.getFolder(nameOrId)

Get folder helper

Kind: instance method of [DedupeThis](#module_Dedupe This!..DedupeThis)

Param Type
nameOrId String

dedupeThis.getEntities()

Get entities helper

Kind: instance method of [DedupeThis](#module_Dedupe This!..DedupeThis)

dedupeThis.dedupe(folder, criteria)

Perform a dedupe against the provided folder using the supplied criteria. Returns both the unique and duplicate entities

Kind: instance method of [DedupeThis](#module_Dedupe This!..DedupeThis)
Todo

  • make this more functional
Param
folder
criteria

dedupeThis.getDuplicateFolder(entityType)

Determines if there is an existing Duplicates folder for the given entityType

Kind: instance method of [DedupeThis](#module_Dedupe This!..DedupeThis)

Param
entityType

dedupeThis.createDuplicatesFolder(entityType)

Creates a Duplicates folder for the given Entity Type. Localized.

Kind: instance method of [DedupeThis](#module_Dedupe This!..DedupeThis)

Param
entityType

dedupeThis.moveEntities(entities, folder)

Moves the given entities to the provided folder

Kind: instance method of [DedupeThis](#module_Dedupe This!..DedupeThis)

Param
entities
folder

form

form~DedupeThisForm

FormApp Class

Kind: inner class of form

new DedupeThisForm(...args)

Instantiate form and worker

Param
...args

dedupeThisForm.getData()

Get data for app render

Kind: instance method of DedupeThisForm
Todo

  • #1 find a better way to get entity properties

dedupeThisForm._getHeaderButtons()

Override the header buttons method

Kind: instance method of DedupeThisForm

dedupeThisForm.activateListeners(html)

Activate app event listeners

Kind: instance method of DedupeThisForm

Param
html

dedupeThisForm._onChangeEntityType(event)

Handle change entity type

Kind: instance method of DedupeThisForm

Param
event

dedupeThisForm._onChangeFolder(event)

Handle change folder

Kind: instance method of DedupeThisForm

Param
event

dedupeThisForm._onClickButton(event)

Handle click

Kind: instance method of DedupeThisForm

Param
event

dedupeThisForm._buildCriteriaObject(formData) ⇒ Object

Builds a Criteria object from the app's form

Kind: instance method of DedupeThisForm
Returns: Object - criteria

Param
formData

dedupeThisForm.preview()

Search for entities using the current formapp's values

Kind: instance method of DedupeThisForm

dedupeThisForm.dedupe()

Performs the dedupe action

Kind: instance method of DedupeThisForm

dedupeThisForm._showWarningDialog()

Shows a warning dialog before deduping

Kind: instance method of DedupeThisForm

DedupeThisForm.defaultOptions

Get defaultOptions for application render

Kind: static property of DedupeThisForm

DedupeThisForm.addSidebarButton(html)

Adds the Dedupe This! button to the sidebar

Kind: static method of DedupeThisForm

Param
html

hooks

hooks.initialiseHooks()

Initialise Hooks for module use

Kind: static method of hooks

settings

module.exports() ⏏

Register module settings

Kind: Exported function

util

util.buildFormData(FD)

Builds a FD returned from _getFormData into a formData array Borrowed from foundry.js

Kind: static method of util

Param Type
FD *

util.getKeyByValue(object, value)

Retrieves a key using the given value

Kind: static method of util

Param Type Description
object Object - the object that contains the key/value
value *

init