feat: enhanced custom function registration#60
Merged
Conversation
Adds enhanced function registration API with type safety and error handling.
Maintain the existing `registerFunction` API for backward compatibility.
```typescript
import { register, search, TYPE_NUMBER } from "@jmespath-community/jmespath";
// TypeScript prevents registering built-in functions at compile time
// register('sum', myFunc, signature); // TypeScript error!
// Enhanced registration with better error handling
const result = register('multiply', ([a, b]) => a * b, [
{ types: [TYPE_NUMBER] },
{ types: [TYPE_NUMBER] }
]);
if (result.success) {
console.log(result.message); // "Function multiply() registered successfully"
} else {
console.error(result.message); // Detailed error information
}
```
```javascript
import { registerFunction, register } from "@jmespath-community/jmespath";
// Option 1: Using registerFunction with options
registerFunction('myFunc', () => 'first', []);
registerFunction('myFunc', () => 'second', [], { override: true, warn: true });
// Console: "Warning: Overriding existing function: myFunc()"
// Option 2: Using enhanced register API
const result = register('myFunc', () => 'third', [], { override: true });
console.log(result.message); // "Function myFunc() overridden successfully"
```
```javascript
import {
isRegistered,
getRegisteredFunctions,
getCustomFunctions,
unregisterFunction,
clearCustomFunctions
} from "@jmespath-community/jmespath";
// Check if function exists
console.log(isRegistered('sum')); // true (built-in)
console.log(isRegistered('myFunc')); // true (if registered)
// Get all registered functions
const allFunctions = getRegisteredFunctions();
console.log(allFunctions); // ['abs', 'avg', 'ceil', ..., 'myFunc']
// Get only custom functions
const customFunctions = getCustomFunctions();
console.log(customFunctions); // ['myFunc', 'divide', ...]
// Unregister custom function (built-ins cannot be unregistered)
const removed = unregisterFunction('myFunc');
console.log(removed); // true if successful
// Clear all custom functions
clearCustomFunctions();
console.log(getCustomFunctions()); // []
```
<!-- ps-id: 6c0db344-9d2c-4393-8899-8d6e92a911fc -->
fb43cd0 to
c7af8f3
Compare
springcomp
approved these changes
Jul 13, 2025
Contributor
|
Thanks, that is an awesome improvement. |
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
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.
Adds enhanced function registration API with type safety and error handling.
Maintain the existing
registerFunctionAPI for backward compatibility.