2023-09-19 02:11:03 +05:30
<!DOCTYPE html> < html class = "default" lang = "en" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > forgejo-notifications-core< / title > < meta name = "description" content = "Documentation for forgejo-notifications-core" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / > < link rel = "stylesheet" href = "assets/style.css" / > < link rel = "stylesheet" href = "assets/highlight.css" / > < script defer src = "assets/main.js" > < / script > < script async src = "assets/search.js" id = "tsd-search-script" > < / script > < script async src = "assets/navigation.js" id = "tsd-nav-script" > < / script > < / head > < body > < script > document . documentElement . dataset . theme = localStorage . getItem ( "tsd-theme" ) || "os" < / script > < header class = "tsd-page-toolbar" >
< div class = "tsd-toolbar-contents container" >
< div class = "table-cell" id = "tsd-search" data-base = "." >
< div class = "field" > < label for = "tsd-search-field" class = "tsd-widget tsd-toolbar-icon search no-caption" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "#icon-search" > < / use > < / svg > < / label > < input type = "text" id = "tsd-search-field" aria-label = "Search" / > < / div >
< div class = "field" >
< div id = "tsd-toolbar-links" > < / div > < / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li > < / ul > < a href = "index.html" class = "title" > forgejo-notifications-core< / a > < / div >
< div class = "table-cell" id = "tsd-widgets" > < a href = "#" class = "tsd-widget tsd-toolbar-icon menu no-caption" data-toggle = "menu" aria-label = "Menu" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "#icon-menu" > < / use > < / svg > < / a > < / div > < / div > < / header >
< div class = "container container-main" >
< div class = "col-content" >
< div class = "tsd-page-title" >
< h2 > forgejo-notifications-core< / h2 > < / div >
< div class = "tsd-panel tsd-typography" > < p > < a href = "https://ci.batsense.net/repos/85" > < img src = "https://ci.batsense.net/api/badges/85/status.svg" alt = "status-badge" > < / a > < / p >
< hr >
2023-09-19 02:46:54 +05:30
< ol >
< li > Docs: < a href = "https://forgejo-notifications-core.docs.forgeflux.org/" > https://forgejo-notifications-core.docs.forgeflux.org/< / a > < / li >
< li > Code coverage: < a href = "https://forgejo-notifications-core.docs.forgeflux.org/coverage/lcov-report/index" > https://forgejo-notifications-core.docs.forgeflux.org/coverage/lcov-report/index< / a > < / li >
< / ol >
2023-09-19 02:11:03 +05:30
< a id = "md:dev-notes" class = "tsd-anchor" > < / a > < h2 > < a href = "#md:dev-notes" > Dev Notes< / a > < / h2 > < p > Requires your Forgejo instance admin to enable CORS for at least the
origin which serves the notification panel. Please see
< a href = "https://forgejo.org/docs/latest/admin/config-cheat-sheet/#cors-cors" > here< / a >
for more information.< / p >
< p > NOTE: The test < a href = "./integration/conf/app.ini" > forgejo configuration< / a > may
be insecure for your usecase since it allows CORS for all origins with
the widest possible surface.< / p >
< a id = "md:build" class = "tsd-anchor" > < / a > < h2 > < a href = "#md:build" > Build< / a > < / h2 > < pre > < code class = "language-bash" > < span class = "hl-0" > pnpm< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > install< / span > < br / > < span class = "hl-0" > pnpm< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > run< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > build< / span >
< / code > < button > Copy< / button > < / pre >
< p > Compiled library will be available at < code > ./dist/index.js< / code > < / p >
< a id = "md:docs" class = "tsd-anchor" > < / a > < h2 > < a href = "#md:docs" > Docs< / a > < / h2 > < p > < a href = "https://forgejo-notifications-core.docs.forgeflux.org" > https://forgejo-notifications-core.docs.forgeflux.org< / a > < / p >
< pre > < code class = "language-bash" > < span class = "hl-0" > pnpm< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > install< / span > < br / > < span class = "hl-0" > pnpm< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > run< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > doc< / span > < br / > < span class = "hl-0" > firefox< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > ./docs/index.html< / span >
< / code > < button > Copy< / button > < / pre >
< a id = "md:tests" class = "tsd-anchor" > < / a > < h2 > < a href = "#md:tests" > Tests< / a > < / h2 > < p > There are [scripts][./integration] to setup a Forgejo instance locally,
create [bunch of]./integration/lib.sh) of users, repository and issues
to test all functionality offered by this library. It might be useful to
recreate this environment with < code > make env.up and ./integration/tests.sh< / code >
for development.< / p >
< p > Uses Docker.< / p >
< pre > < code class = "language-bash" > < span class = "hl-0" > pnpm< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > install< / span > < br / > < span class = "hl-0" > make< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > env.up< / span > < br / > < span class = "hl-0" > make< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > test< / span >
< / code > < button > Copy< / button > < / pre >
< / div > < / div >
< div class = "col-sidebar" >
< div class = "page-menu" >
< div class = "tsd-navigation settings" >
< details class = "tsd-index-accordion" > < summary class = "tsd-accordion-summary" >
< h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "#icon-chevronDown" > < / use > < / svg > Settings< / h3 > < / summary >
< div class = "tsd-accordion-details" >
< div class = "tsd-filter-visibility" >
< h4 class = "uppercase" > Member Visibility< / h4 > < form >
< ul id = "tsd-filter-options" >
< li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-protected" name = "protected" / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < use href = "#icon-checkbox" > < / use > < / svg > < span > Protected< / span > < / label > < / li >
< li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-private" name = "private" / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < use href = "#icon-checkbox" > < / use > < / svg > < span > Private< / span > < / label > < / li >
< li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-inherited" name = "inherited" checked / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < use href = "#icon-checkbox" > < / use > < / svg > < span > Inherited< / span > < / label > < / li >
< li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-external" name = "external" / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < use href = "#icon-checkbox" > < / use > < / svg > < span > External< / span > < / label > < / li > < / ul > < / form > < / div >
< div class = "tsd-theme-toggle" >
< h4 class = "uppercase" > Theme< / h4 > < select id = "tsd-theme" > < option value = "os" > OS< / option > < option value = "light" > Light< / option > < option value = "dark" > Dark< / option > < / select > < / div > < / div > < / details > < / div >
< details open class = "tsd-index-accordion tsd-page-navigation" > < summary class = "tsd-accordion-summary" >
< h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "#icon-chevronDown" > < / use > < / svg > On This Page< / h3 > < / summary >
< div class = "tsd-accordion-details" >
< ul >
< li >
< ul >
< li > < a href = "#md:dev-notes" > < span > Dev < wbr / > Notes< / span > < / a > < / li >
< li >
< ul >
< li > < a href = "#md:build" > < span > Build< / span > < / a > < / li >
< li > < a href = "#md:docs" > < span > Docs< / span > < / a > < / li >
< li > < a href = "#md:tests" > < span > Tests< / span > < / a > < / li > < / ul > < / li > < / ul > < / li > < / ul > < / div > < / details > < / div >
< div class = "site-menu" >
2023-09-19 03:08:26 +05:30
< nav class = "tsd-navigation" > < a href = "modules.html" class = "current" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1" > < / use > < / svg > < span > forgejo-notifications-core< / span > < / a >
2023-09-19 02:11:03 +05:30
< ul class = "tsd-small-nested-navigation" id = "tsd-nav-container" data-base = "." >
2023-09-19 03:09:25 +05:30
< li > < a href = "classes/default.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-128" > < / use > < / svg > default< / a > < / li > < / ul > < / nav > < / div > < / div > < / div >
2023-09-19 02:11:03 +05:30
< div class = "tsd-generator" >
< p > Generated using < a href = "https://typedoc.org/" rel = "noopener" target = "_blank" > TypeDoc< / a > < / p > < / div >
< div class = "overlay" > < / div > < svg style = "display: none" > < g id = "icon-1" > < rect fill = "var(--color-icon-background)" stroke = "var(--color-ts-namespace)" stroke-width = "1.5" x = "1" y = "1" width = "22" height = "22" rx = "6" > < / rect > < path d = "M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill = "var(--color-text)" > < / path > < / g > < g id = "icon-2" > < rect fill = "var(--color-icon-background)" stroke = "var(--color-ts-namespace)" stroke-width = "1.5" x = "1" y = "1" width = "22" height = "22" rx = "6" > < / rect > < path d = "M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill = "var(--color-text)" > < / path > < / g > < g id = "icon-4" > < rect fill = "var(--color-icon-background)" stroke = "var(--color-ts-namespace)" stroke-width = "1.5" x = "1" y = "1" width = "22" height = "22" rx = "6" > < / rect > < path d = "M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill = "var(--color-text)" > < / path > < / g > < g id = "icon-8" > < rect fill = "var(--color-icon-background)" stroke = "var(--color-ts-enum)" stroke-width = "1.5" x = "1" y = "1" width = "22" height = "22" rx = "6" > < / rect > < path d = "M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill = "var(--color-text)" > < / path > < / g > < g id = "icon-16" > < rect fill = "var(--color-icon-background)" stroke = "#FF984D" stroke-width = "1.5" x = "1" y = "1" width = "22" height = "22" rx = "12" > < / rect > < path d = "M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill = "var(--color-text)" > < / path > < / g > < g id = "icon-32" > < rect fill = "var(--color-icon-background)" stroke = "var(--color-ts-variable)" stroke-width = "1.5" x = "1" y = "1" width = "22" height = "22" rx = "6" > < / rect > < path d = "M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill = "var(--color-text)" > < / path > < / g > < g id = "icon-64" > < rect fill = "var(--color-icon-background)" stroke = "var(--color-ts-function)" stroke-width = "1.5" x = "1" y = "1" width = "22" height = "22" rx = "6" > < / rect > < path d = "M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill = "var(--color-text)" > < / path > < / g > < g id = "icon-128" > < rect fill = "var(--color-icon-background)" stroke = "var(--color-ts-class)" stroke-width = "1.5" x = "1" y = "1" width = "22" height = "22" rx = "6" > < / rect > < path d = "M11.898 16 . 1201C11 . 098 16 . 1201 10 . 466 15 . 8961 10 . 002 15 . 4481C9 . 53803 15 . 0001 9 . 30603 14 . 3841 9 . 30603 13 . 6001V9 . 64012C9 . 30603 8 . 85612 9 . 53803 8 . 24012 10 . 002 7 . 79212C10 . 466 7 . 34412 11 . 098 7 . 12012 11 . 898 7 . 12012C12 . 682 7 . 12012 13 . 306 7 . 34812 13 . 77 7 . 80412C14 . 234 8 . 25212 14 . 466 8 . 86412 14 . 466 9 . 64012H13 . 386C13 . 386 9 . 14412 13 . 254 8 . 76412 12 . 99 8 . 50012C12 . 734 8 . 22812 12 . 37 8 . 09212 11 . 898 8 . 09212C11 . 426 8 . 09212 11 . 054 8 . 22412 10 . 782 8 . 48812C10 . 518 8 . 75212 10 . 386 9 . 13212 10 . 386 9 . 62812V13 . 6001C10 . 386 14 . 0961 10 . 518 14 . 4801 10 . 782 14 . 7521C11 . 054 15 . 0161 11 . 426 15 . 1481 11 . 898 15 . 1481C12 . 37 15 . 1481 12 . 734 15 . 0161 12 . 99 14 . 7521C13 . 254 14 . 4801 13 . 386 14 . 0961 13 . 386 13 . 6001H14 . 466C14 . 466 14 . 3761 14 . 234 14 . 9921 13 . 77 15 . 4481C13 . 306 15 . 8961 12 . 682 16 . 120
