variablelab/theatre
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add comments to validateCommonOpts()

Browse source
This commit is contained in:
Aria Minaei 2022-04-09 17:12:52 +02:00
parent 72ada325be
commit 64874d644b
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
theatre/core/src/propTypes/index.ts
View file

@ -23,6 +23,13 @@ import {propTypeSymbol} from './internals'
// Composite types are not directly sequenceable yet. Their simple sub/ancestor props are. // Composite types are not directly sequenceable yet. Their simple sub/ancestor props are.
// We’ll provide a nice UX to manage keyframing of multiple sub-props. // We’ll provide a nice UX to manage keyframing of multiple sub-props.
/**
* Validates the common options given to all prop types, such as `opts.label`
*
* @param fnCallSignature - See references for examples
* @param opts - The common options of all prop types
* @returns void - will throw if options are invalid
*/
const validateCommonOpts = (fnCallSignature: string, opts?: CommonOpts) => { const validateCommonOpts = (fnCallSignature: string, opts?: CommonOpts) => {
if (process.env.NODE_ENV !== 'production') { if (process.env.NODE_ENV !== 'production') {
if (opts === undefined) return if (opts === undefined) return