[tools][docs] bump TypeDoc to the latest 0.24 release, regenerate data (

expo#25532)

docs/components/plugins/api/APISectionProps.tsx

@@ -46,7 +46,7 @@ const extractDefaultPropValue = (
 ): string | undefined => {
   const annotationDefault = getTagData('default', comment);
   if (annotationDefault) {
-    return getCommentContent(annotationDefault.content);
+    return getCommentContent(annotationDefault.content, true);
   }
   return defaultProps?.type?.declaration?.children?.filter(
     (defaultProp: PropData) => defaultProp.name === name

docs/components/plugins/api/APISectionUtils.tsx

@@ -574,11 +574,16 @@ const getParamTags = (shortText?: string) => {
   return Array.from(shortText.matchAll(PARAM_TAGS_REGEX), match => match[0]);
 };
 
-export const getCommentContent = (content: CommentContentData[]) => {
-  return content
+export const getCommentContent = (content: CommentContentData[], ignoreCodeBlock = false) => {
+  const commentText = content
     .map(entry => entry.text)
     .join('')
     .trim();
+
+  if (ignoreCodeBlock) {
+    return commentText.replace(/```.+\n/, '').replace(/\n```/, '');
+  }
+  return commentText;
 };
 
 export const CommentTextBlock = ({

docs/public/static/data/unversioned/expo-background-fetch.json

@@ -1 +1 @@
-{"name":"expo-background-fetch","kind":1,"children":[{"name":"BackgroundFetchResult","kind":8,"comment":{"summary":[{"kind":"text","text":"This return value is to let iOS know what the result of your background fetch was, so the\nplatform can better schedule future background fetches. Also, your app has up to 30 seconds\nto perform the task, otherwise your app will be terminated and future background fetches\nmay be delayed."}]},"children":[{"name":"Failed","kind":16,"comment":{"summary":[{"kind":"text","text":"An attempt to download data was made but that attempt failed."}]},"type":{"type":"literal","value":3}},{"name":"NewData","kind":16,"comment":{"summary":[{"kind":"text","text":"New data was successfully downloaded."}]},"type":{"type":"literal","value":2}},{"name":"NoData","kind":16,"comment":{"summary":[{"kind":"text","text":"There was no new data to download."}]},"type":{"type":"literal","value":1}}]},{"name":"BackgroundFetchStatus","kind":8,"children":[{"name":"Available","kind":16,"comment":{"summary":[{"kind":"text","text":"Background updates are available for the app."}]},"type":{"type":"literal","value":3}},{"name":"Denied","kind":16,"comment":{"summary":[{"kind":"text","text":"The user explicitly disabled background behavior for this app or for the whole system."}]},"type":{"type":"literal","value":1}},{"name":"Restricted","kind":16,"comment":{"summary":[{"kind":"text","text":"Background updates are unavailable and the user cannot enable them again. This status can occur\nwhen, for example, parental controls are in effect for the current user."}]},"type":{"type":"literal","value":2}}]},{"name":"BackgroundFetchOptions","kind":256,"children":[{"name":"minimumInterval","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Inexact interval in seconds between subsequent repeats of the background fetch alarm. The final\ninterval may differ from the specified one to minimize wakeups and battery usage.\n- On Android it defaults to __10 minutes__,\n- On iOS it calls ["},{"kind":"code","text":"`BackgroundFetch.setMinimumIntervalAsync`"},{"kind":"text","text":"](#backgroundfetchsetminimumintervalasyncminimuminterval)\n  behind the scenes and the default value is the smallest fetch interval supported by the system __(10-15 minutes)__.\nBackground fetch task receives no data, but your task should return a value that best describes\nthe results of your background fetch work."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"Returns a promise that fulfils once the task is registered and rejects in case of any errors."}]}]},"type":{"type":"intrinsic","name":"number"}},{"name":"startOnBoot","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether to restart background fetch events when the device has finished booting."}],"blockTags":[{"tag":"@default","content":[{"kind":"text","text":"false"}]},{"tag":"@platform","content":[{"kind":"text","text":"android"}]}]},"type":{"type":"intrinsic","name":"boolean"}},{"name":"stopOnTerminate","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether to stop receiving background fetch events after user terminates the app."}],"blockTags":[{"tag":"@default","content":[{"kind":"text","text":"true"}]},{"tag":"@platform","content":[{"kind":"text","text":"android"}]}]},"type":{"type":"intrinsic","name":"boolean"}}]},{"name":"getStatusAsync","kind":64,"signatures":[{"name":"getStatusAsync","kind":4096,"comment":{"summary":[{"kind":"text","text":"Gets a status of background fetch."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"Returns a promise which fulfils with one of "},{"kind":"code","text":"`BackgroundFetchStatus`"},{"kind":"text","text":" enum values."}]}]},"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"reference","name":"BackgroundFetchStatus"},{"type":"literal","value":null}]}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"name":"registerTaskAsync","kind":64,"signatures":[{"name":"registerTaskAsync","kind":4096,"comment":{"summary":[{"kind":"text","text":"Registers background fetch task with given name. Registered tasks are saved in persistent storage and restored once the app is initialized."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```ts\nimport * as BackgroundFetch from 'expo-background-fetch';\nimport * as TaskManager from 'expo-task-manager';\n\nTaskManager.defineTask(YOUR_TASK_NAME, () => {\n  try {\n    const receivedNewData = // do your background fetch here\n    return receivedNewData ? BackgroundFetch.BackgroundFetchResult.NewData : BackgroundFetch.BackgroundFetchResult.NoData;\n  } catch (error) {\n    return BackgroundFetch.BackgroundFetchResult.Failed;\n  }\n});\n```"}]}]},"parameters":[{"name":"taskName","kind":32768,"comment":{"summary":[{"kind":"text","text":"Name of the task to register. The task needs to be defined first - see ["},{"kind":"code","text":"`TaskManager.defineTask`"},{"kind":"text","text":"](taskmanager#defineTask)\nfor more details."}]},"type":{"type":"intrinsic","name":"string"}},{"name":"options","kind":32768,"comment":{"summary":[{"kind":"text","text":"An object containing the background fetch options."}]},"type":{"type":"reference","name":"BackgroundFetchOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"name":"setMinimumIntervalAsync","kind":64,"signatures":[{"name":"setMinimumIntervalAsync","kind":4096,"comment":{"summary":[{"kind":"text","text":"Sets the minimum number of seconds that must elapse before another background fetch can be\ninitiated. This value is advisory only and does not indicate the exact amount of time expected\nbetween fetch operations.\n\n> This method doesn't take any effect on Android. It is a global value which means that it can\noverwrite settings from another application opened through Expo Go."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"A promise which fulfils once the minimum interval is set."}]}]},"parameters":[{"name":"minimumInterval","kind":32768,"comment":{"summary":[{"kind":"text","text":"Number of seconds that must elapse before another background fetch can be called."}]},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"name":"unregisterTaskAsync","kind":64,"signatures":[{"name":"unregisterTaskAsync","kind":4096,"comment":{"summary":[{"kind":"text","text":"Unregisters background fetch task, so the application will no longer be executing this task."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"A promise which fulfils when the task is fully unregistered."}]}]},"parameters":[{"name":"taskName","kind":32768,"comment":{"summary":[{"kind":"text","text":"Name of the task to unregister."}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]}]}
+{"name":"expo-background-fetch","variant":"project","kind":1,"children":[{"name":"BackgroundFetchResult","variant":"declaration","kind":8,"comment":{"summary":[{"kind":"text","text":"This return value is to let iOS know what the result of your background fetch was, so the\nplatform can better schedule future background fetches. Also, your app has up to 30 seconds\nto perform the task, otherwise your app will be terminated and future background fetches\nmay be delayed."}]},"children":[{"name":"Failed","variant":"declaration","kind":16,"comment":{"summary":[{"kind":"text","text":"An attempt to download data was made but that attempt failed."}]},"type":{"type":"literal","value":3}},{"name":"NewData","variant":"declaration","kind":16,"comment":{"summary":[{"kind":"text","text":"New data was successfully downloaded."}]},"type":{"type":"literal","value":2}},{"name":"NoData","variant":"declaration","kind":16,"comment":{"summary":[{"kind":"text","text":"There was no new data to download."}]},"type":{"type":"literal","value":1}}]},{"name":"BackgroundFetchStatus","variant":"declaration","kind":8,"children":[{"name":"Available","variant":"declaration","kind":16,"comment":{"summary":[{"kind":"text","text":"Background updates are available for the app."}]},"type":{"type":"literal","value":3}},{"name":"Denied","variant":"declaration","kind":16,"comment":{"summary":[{"kind":"text","text":"The user explicitly disabled background behavior for this app or for the whole system."}]},"type":{"type":"literal","value":1}},{"name":"Restricted","variant":"declaration","kind":16,"comment":{"summary":[{"kind":"text","text":"Background updates are unavailable and the user cannot enable them again. This status can occur\nwhen, for example, parental controls are in effect for the current user."}]},"type":{"type":"literal","value":2}}]},{"name":"BackgroundFetchOptions","variant":"declaration","kind":256,"children":[{"name":"minimumInterval","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Inexact interval in seconds between subsequent repeats of the background fetch alarm. The final\ninterval may differ from the specified one to minimize wakeups and battery usage.\n- On Android it defaults to __10 minutes__,\n- On iOS it calls ["},{"kind":"code","text":"`BackgroundFetch.setMinimumIntervalAsync`"},{"kind":"text","text":"](#backgroundfetchsetminimumintervalasyncminimuminterval)\n  behind the scenes and the default value is the smallest fetch interval supported by the system __(10-15 minutes)__.\nBackground fetch task receives no data, but your task should return a value that best describes\nthe results of your background fetch work."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"Returns a promise that fulfils once the task is registered and rejects in case of any errors."}]}]},"type":{"type":"intrinsic","name":"number"}},{"name":"startOnBoot","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether to restart background fetch events when the device has finished booting."}],"blockTags":[{"tag":"@default","content":[{"kind":"code","text":"```ts\nfalse\n```"}]},{"tag":"@platform","content":[{"kind":"text","text":"android"}]}]},"type":{"type":"intrinsic","name":"boolean"}},{"name":"stopOnTerminate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether to stop receiving background fetch events after user terminates the app."}],"blockTags":[{"tag":"@default","content":[{"kind":"code","text":"```ts\ntrue\n```"}]},{"tag":"@platform","content":[{"kind":"text","text":"android"}]}]},"type":{"type":"intrinsic","name":"boolean"}}]},{"name":"getStatusAsync","variant":"declaration","kind":64,"signatures":[{"name":"getStatusAsync","variant":"signature","kind":4096,"comment":{"summary":[{"kind":"text","text":"Gets a status of background fetch."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"Returns a promise which fulfils with one of "},{"kind":"code","text":"`BackgroundFetchStatus`"},{"kind":"text","text":" enum values."}]}]},"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"reference","name":"BackgroundFetchStatus","package":"expo-background-fetch"},{"type":"literal","value":null}]}],"name":"Promise","package":"typescript"}}]},{"name":"registerTaskAsync","variant":"declaration","kind":64,"signatures":[{"name":"registerTaskAsync","variant":"signature","kind":4096,"comment":{"summary":[{"kind":"text","text":"Registers background fetch task with given name. Registered tasks are saved in persistent storage and restored once the app is initialized."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```ts\nimport * as BackgroundFetch from 'expo-background-fetch';\nimport * as TaskManager from 'expo-task-manager';\n\nTaskManager.defineTask(YOUR_TASK_NAME, () => {\n  try {\n    const receivedNewData = // do your background fetch here\n    return receivedNewData ? BackgroundFetch.BackgroundFetchResult.NewData : BackgroundFetch.BackgroundFetchResult.NoData;\n  } catch (error) {\n    return BackgroundFetch.BackgroundFetchResult.Failed;\n  }\n});\n```"}]}]},"parameters":[{"name":"taskName","variant":"param","kind":32768,"comment":{"summary":[{"kind":"text","text":"Name of the task to register. The task needs to be defined first - see ["},{"kind":"code","text":"`TaskManager.defineTask`"},{"kind":"text","text":"](taskmanager#defineTask)\nfor more details."}]},"type":{"type":"intrinsic","name":"string"}},{"name":"options","variant":"param","kind":32768,"comment":{"summary":[{"kind":"text","text":"An object containing the background fetch options."}]},"type":{"type":"reference","name":"BackgroundFetchOptions","package":"expo-background-fetch"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"}}]},{"name":"setMinimumIntervalAsync","variant":"declaration","kind":64,"signatures":[{"name":"setMinimumIntervalAsync","variant":"signature","kind":4096,"comment":{"summary":[{"kind":"text","text":"Sets the minimum number of seconds that must elapse before another background fetch can be\ninitiated. This value is advisory only and does not indicate the exact amount of time expected\nbetween fetch operations.\n\n> This method doesn't take any effect on Android. It is a global value which means that it can\noverwrite settings from another application opened through Expo Go."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"A promise which fulfils once the minimum interval is set."}]}]},"parameters":[{"name":"minimumInterval","variant":"param","kind":32768,"comment":{"summary":[{"kind":"text","text":"Number of seconds that must elapse before another background fetch can be called."}]},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"}}]},{"name":"unregisterTaskAsync","variant":"declaration","kind":64,"signatures":[{"name":"unregisterTaskAsync","variant":"signature","kind":4096,"comment":{"summary":[{"kind":"text","text":"Unregisters background fetch task, so the application will no longer be executing this task."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"A promise which fulfils when the task is fully unregistered."}]}]},"parameters":[{"name":"taskName","variant":"param","kind":32768,"comment":{"summary":[{"kind":"text","text":"Name of the task to unregister."}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"}}]}],"packageName":"expo-background-fetch"}