jgaunt/CyberChef
2
0
Fork 0
mirror of https://github.com/gchq/CyberChef synced 2025-12-10 21:33:36 +00:00
Code Issues Releases Wiki Activity

add info on argOptions

d98762625
2018-12-21 09:46:55 +00:00
parent 6978d32f0d
commit b0c2d95ac1
1 changed files with 17 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
Node-API.md

@@ -144,7 +144,7 @@ chef.toCharcode("Service!", {
// => 123 145 162 166 151 143 145 41 // => 123 145 162 166 151 143 145 41
``` ```
Where arguments are options, they will need to be displayed exactly as on the UI. For example: Where arguments are options, they are case sensitive. It is recommended to use the argOptions property of the operation. For example:
```javascript ```javascript
// OK // OK
chef.convertDistance(122, { chef.convertDistance(122, {
@@ -153,6 +153,13 @@ chef.convertDistance(122, {
}); });
// => 30500 // => 30500
// Less error-prone
chef.convertDistance(122, {
inputUnits: chef.convertDistance.argOptions.inputUnits[5],
outputUnits: chef.convertDistance.argOptions.outputUnits[17]
});
// => 30500
// Invalid outputUnits value // Invalid outputUnits value
chef.convertDistance(122, { chef.convertDistance(122, {
inputUnits: "Kilometers (km)", inputUnits: "Kilometers (km)",
@@ -161,6 +168,7 @@ chef.convertDistance(122, {
// => NaN // => NaN
``` ```
#### Operation input #### Operation input
Operations accept a wide range of input types. For most cases, you can throw any input type at an operation and it will deal with it. Operations accept a wide range of input types. For most cases, you can throw any input type at an operation and it will deal with it.
@@ -173,7 +181,7 @@ JavaScript objects are accepted as input to operations that expect JSON, for exa
#### Operation arguments #### Operation arguments
Operation arguments are the second argument in an operation call. The best way to see an operation's arguments is to use `chef.help(<argument name here>)` or consult the UI. Operation arguments are the second argument in an operation call. The best way to see an operation's arguments is to use `chef.help(<argument name here>)` or consult the UI.
Some operation arguments have default values. Some, for example `AESEncrypt`, will not work without specifying some argument. Some operation arguments have default values. Some, like `AESEncrypt` for example, will not work without specifying some argument.
##### Number, String, binaryString and boolean arguments ##### Number, String, binaryString and boolean arguments
Declare these arguments as key value pairs, where the key is the argument name. Declare these arguments as key value pairs, where the key is the argument name.
@@ -193,13 +201,18 @@ chef.toBase32("diamond", {
``` ```
##### Option arguments ##### Option arguments
These are arguments represented as dropdowns in the UI. Here the string value must be an exact match for the option string. These are arguments represented as dropdowns in the UI. Here the string value must be an exact match for the option string. For convenience, it is recommended to use the `argOptions` property of the operation.
Example: `toDecimal` Example: `toDecimal`
```javascript ```javascript
chef.toDecimal("Hello", { chef.toDecimal("Hello", {
delimiter: "Colon", // note case sensitive delimiter: "Colon", // note case sensitive
}); });
// Equivalent and less error-prone:
chef.toDecimal("Hello", {
delimiter: chef.toDecimal.argOptions.delimiter[3]
})
``` ```
##### toggleString arguments ##### toggleString arguments
@@ -217,7 +230,7 @@ Example: `ADD` with explicit encoding
chef.ADD("abc", { chef.ADD("abc", {
key: { key: {
string: "abc", string: "abc",
option: "utf8", option: chef.ADD.argOptions.key[4],
}, },
}); });
``` ```