{"id":3219,"date":"2019-07-23T08:00:25","date_gmt":"2019-07-23T16:00:25","guid":{"rendered":"https:\/\/developer.microsoft.com\/en-us\/office\/blogs\/?p=3219"},"modified":"2019-07-23T08:00:25","modified_gmt":"2019-07-23T16:00:25","slug":"update-your-customs-functions-project","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/update-your-customs-functions-project\/","title":{"rendered":"Update your custom functions project"},"content":{"rendered":"

Update an old project<\/span>\u00a0<\/span><\/h3>\n

If you built your custom functions project using the\u00a0<\/span>Yo<\/span>\u00a0Office Yeoman generator template<\/span><\/a>\u00a0during the preview period prior to 6 May 2019, you\u2019ll want to update parts of the project ensure it is using the GA version libraries and features.\u00a0<\/span>\u00a0<\/span><\/p>\n

To convert a project:\u00a0<\/span>\u00a0<\/span><\/p>\n

Update the CDN location<\/span>\u00a0<\/span><\/h3>\n

The post-GA\u00a0<\/span>Yo<\/span>\u00a0Office template included a change to the\u00a0<\/span>script file<\/span>\u00a0that governs the custom functions’ runtime<\/span>\u00a0and moved from a temporary\u00a0<\/span>GitHub<\/span>\u00a0location to a permanent CDN on https:\/\/appsforoffice.microsoft.com\/<\/a>.<\/span>\u00a0<\/span><\/p>\n

In the<\/span>\u00a0HTML file for your add-in<\/span>, delete t<\/span>he<\/span>\u00a0script reference<\/span>\u00a0which is used to load custom-function-runtime.js. Because the preview\u00a0<\/span>Yo<\/span>\u00a0Office template changed frequently, this might refer to a temporary\u00a0<\/span>GitHub<\/span>\u00a0location like the following code snippet, but you may see a different location depending on your project.\u00a0<\/span>\u00a0<\/span><\/p>\n

<script\u00a0src=\"https:\/\/officedev.github.io\/custom-functions\/lib\/custom-functions-runtime.js\"\u00a0type=\"text\/javascript\"><\/script><\/pre>\n
\u00a0<\/span>And replace it with this script reference instead<\/span>, which includes the updated CDN location:\u00a0<\/span>\u00a0<\/span><\/p>\n
<script\u00a0src=\"https:\/\/appsforoffice.microsoft.com\/lib\/1.1\/hosted\/custom-functions-runtime.js\"\u00a0type=\"text\/javascript\"><\/script><\/pre>\n
To learn more about this runtime<\/span>, see<\/span>\u00a0our docs on the\u00a0<\/span>custom functions architecture<\/span><\/a>.<\/span>\u00a0<\/span><\/p>\n
Change any mentions of\u00a0 ‘<\/span>AsyncStorage‘ to ‘s<\/span>torage’<\/span>\u00a0<\/span><\/h3>\n
The <\/span>AsyncStorage<\/strong>\u00a0<\/strong>object\u00a0<\/span>was<\/span>\u00a0rewritten with different methods and a new name. You’ll want to make sure all mentions of <\/span>AsyncStorage<\/strong>\u00a0<\/strong>use the new object, storage<\/strong>. Method changes are listed\u00a0<\/span>in the following table<\/span>, although you can also use the built-in IntelliSense in Visual Studio Code to look for correct methods.\u00a0\u00a0<\/span>\u00a0<\/span><\/p>\n
The following table lists the methods that are changed:<\/p>\n\n\n\n\n\n\n\n
Old method\u00a0<\/strong><\/td>\nNew replacement\u00a0<\/strong><\/td>\n<\/tr>\n
multiGet<\/span>\u00a0<\/span><\/td>\ngetItems<\/span>\u00a0<\/span><\/td>\n<\/tr>\n
Multiset<\/span>\u00a0<\/span><\/td>\nsetItems<\/span>\u00a0<\/span><\/td>\n<\/tr>\n
multiRemove<\/span>\u00a0<\/span><\/td>\nremoveItems<\/span>\u00a0<\/span><\/td>\n<\/tr>\n
getAllKeys<\/span>\u00a0<\/span><\/td>\ngetKeys<\/span>\u00a0<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\u00a0<\/span><\/p>\n
Deprecated methods:\u00a0<\/span>\u00a0<\/span><\/p>\n