Move plugins to SpreadsheetOptions and getConfig to SpreadsheetInstance in the type definitions - #1806
Open
YuEfSaEDU wants to merge 1 commit into
Open
Move plugins to SpreadsheetOptions and getConfig to SpreadsheetInstance in the type definitions#1806YuEfSaEDU wants to merge 1 commit into
YuEfSaEDU wants to merge 1 commit into
Conversation
Move plugins from WorksheetOptions to SpreadsheetOptions, since the runtime reads it from the top-level options (factory.js: spreadsheet.setPlugins(options.plugins)). Move getConfig from the Plugin interface to SpreadsheetInstance, since the runtime binds it to the spreadsheet instance (factory.js: spreadsheet.getConfig = getSpreadsheetConfig.bind(spreadsheet)). Fixes jspreadsheet#1803
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Both members are verified against the runtime before moving:
pluginsis read from the top-level spreadsheet options (spreadsheet.setPlugins(options.plugins)insrc/utils/factory.js), never from per-worksheet options — soplugins?: Record<string, () => Plugin>belongs inSpreadsheetOptions, notWorksheetOptions.getConfigis bound asspreadsheet.getConfig = getSpreadsheetConfig.bind(spreadsheet); nothing in the runtime ever callsplugin.getConfig— sogetConfig: () => SpreadsheetOptionsbelongs inSpreadsheetInstance, not thePlugininterface.With this
dist/index.d.ts, a usage snippet withpluginsat spreadsheet level andspreadsheet.getConfig()type-checks (tscexit 0); against the previous file it reproduces exactly the two reported errors (TS2353: 'plugins' does not exist in type 'SpreadsheetOptions',TS2551: Property 'getConfig' does not exist on type 'SpreadsheetInstance').WorksheetInstance.getConfig(worksheet-level) was already correct and is untouched.Fixes #1803