Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To find all references to our APIs when writing Profound.js modules, you must require the ‘profoundjs’ module in your script.

From there, any time you reference the ‘pjs’ namespace VSCode will prompt you with a list of Profound.js methods available for you to use. VSCode will also show you their parameters and a short description of the API.

VSCode is especially helpful when working with the Profound.js SQL APIs. The ‘pjs.prepare()’ API returns an object which has more functions. In an object-orientated world, you could compare the ‘prepare’ function to a constructor and the return object being a new class with methods.

 

When referencing the object (class), you will get a list of methods available from within that object. As you start to type the list of parameters, VSCode will tell you what the parameter type is and also a description of it as seen here:

As of Profound.js 4.2.8, when developing with Visual Studio Code [1] you will have access to the Profound.js APIs via the Intellisense. Intellisense is used for understanding references in your code. For example, when writing JavaScript it can list available functions, variables, among other things. Intellisense is also known as content-assist.

To find all references to our APIs when writing Profound.js modules, you must require the ‘profoundjs’ module in your script.