https://rune-docs.netlify.app/assets/js/3e72ce53.2a925605.js

1"use strict";(globalThis.webpackChunkwebsite=globalThis.webpackChunkwebsite||[]).push([[188],{8453(e,n,o){o.d(n,{R:()=>t,x:()=>l});var s=o(6540);const r={},i=s.createContext(r);function t(e){const n=s.useContext(i);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),s.createElement(i.Provider,{value:n},e.children)}},8615(e,n,o){o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>a,frontMatter:()=>t,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"get-started/rune-keywords","title":"Rune keywords","description":"Use keywords to find the functions you\'re looking for, fast.","source":"@site/docs/get-started/rune-keywords.mdx","sourceDirName":"get-started","slug":"/get-started/rune-keywords","permalink":"/docs/get-started/rune-keywords","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"title":"Rune keywords","sidebar_label":"Rune keywords","description":"Use keywords to find the functions you\'re looking for, fast."},"sidebar":"docsSidebar","previous":{"title":"Get started","permalink":"/docs/get-started"},"next":{"title":"Overview","permalink":"/docs/get-started/overview"}}');var r=o(4848),i=o(8453);const t={title:"Rune keywords",sidebar_label:"Rune keywords",description:"Use keywords to find the functions you're looking for, fast."},l="Rune keywords",d={},c=[];function p(e){const n={a:"a",code:"code",h1:"h1",header:"header",p:"p",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"rune-keywords",children:"Rune keywords"})}),"\n",(0,r.jsx)(n.p,{children:"For quick access to documentation for a Rune type, function, expression or annotation, choose a keyword to link to the relevant documentation."}),"\n",(0,r.jsxs)("table",{style:{width:"100%",borderCollapse:"collapse"},children:[(0,r.jsx)("thead",{children:(0,r.jsxs)("tr",{style:{backgroundColor:"var(--ifm-color-emphasis-100)"},children:[(0,r.jsx)("th",{style:{padding:"10px",textAlign:"left",width:"200px"},children:"Category"}),(0,r.jsx)("th",{style:{padding:"10px",textAlign:"left"},children:"Keywords"})]})}),(0,r.jsxs)("tbody",{children:[(0,r.jsxs)("tr",{children:[(0,r.jsx)("td",{style:{verticalAlign:"top",padding:"10px"},children:(0,r.jsx)("strong",{children:"Structural"})}),(0,r.jsxs)("td",{style:{padding:"10px"},children:[(0,r.jsx)("div",{style:{display:"flex",flexWrap:"wrap",gap:"10px"},children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)("strong",{children:"Types"}),":\n",(0,r.jsx)(n.a,{href:"../modelling-components/data#11-basic-types",children:"basicType"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/data#23-choice-type-union-type",children:"choice"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/data#3-enumeration-enum",children:"displayName"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/data#3-enumeration-enum",children:"enum"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/mapping#12-extending-a-synonym-source",children:"extends"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/data#13-record-types",children:"recordType"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/data#data-component-types",children:"type"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/data#type-aliases",children:"typeAlias"})]})}),(0,r.jsx)("div",{style:{display:"flex",flexWrap:"wrap",gap:"10px",marginTop:"10px"},children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)("strong",{children:"Namespaces"}),":\n",(0,r.jsx)(n.a,{href:"../modelling-components/namespace",children:"import"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/namespace",children:"namespace"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/reporting#4-function-overriding",children:"version"})]})})]})]}),(0,r.jsxs)("tr",{children:[(0,r.jsx)("td",{style:{verticalAlign:"top",padding:"10px"},children:(0,r.jsx)("strong",{children:"Functional"})}),(0,r.jsxs)("td",{style:{padding:"10px"},children:[(0,r.jsx)("div",{style:{display:"flex",flexWrap:"wrap",gap:"10px"},children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)("strong",{children:"Functions"}),":\n",(0,r.jsx)(n.a,{href:"../modelling-components/function#21-output-construction",children:"add"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/data#type-aliases",children:"alias"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/metadata#1-annotations",children:"func"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/function#1-function-specification",children:"inputs"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/function#1-function-specification",children:"output"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/function#21-output-construction",children:"set"})]})}),(0,r.jsx)("div",{style:{display:"flex",flexWrap:"wrap",gap:"10px",marginTop:"10px"},children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)("strong",{children:"Regulatory reporting"}),":\n",(0,r.jsx)(n.a,{href:"../modelling-components/metadata#21-document-hierarchy",children:"body"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/metadata#21-document-hierarchy",children:"corpus"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/reporting#2-report-definition",children:"in"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/reporting#2-report-definition",children:"from"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/reporting#2-report-definition",children:"report"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/reporting#2-report-definition",children:"reporting"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/reporting#3-report-rules",children:"rule"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/metadata#21-document-hierarchy",children:"segment"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/mapping#11-synonym-source",children:"source"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/mapping#23-conditional-mappings",children:"when"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/reporting#2-report-definition",children:"with type"})]})}),(0,r.jsx)("div",{style:{display:"flex",flexWrap:"wrap",gap:"10px",marginTop:"10px"},children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)("strong",{children:"Conditions"}),":\n",(0,r.jsx)(n.a,{href:"../modelling-components/function#14-conditions",children:"condition"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/function#14-conditions",children:"post-condition"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/function#14-conditions",children:"pre-condition"})]})}),(0,r.jsx)("div",{style:{display:"flex",flexWrap:"wrap",gap:"10px",marginTop:"10px"},children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)("strong",{children:"Expressions"}),":\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#1-constant-expressions",children:"empty"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#31-conditional-statements",children:"False"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#31-conditional-statements",children:"True"})]})}),(0,r.jsx)("div",{style:{display:"flex",flexWrap:"wrap",gap:"10px",marginTop:"10px"},children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)("strong",{children:"Control flow"}),":\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#3-operators",children:"else"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#41-list-operator-keywords",children:"extract"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#3-operators",children:"if"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/reporting#43-super-call",children:"super"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#3-operators",children:"switch"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#41-list-operator-keywords",children:"then"})]})}),(0,r.jsx)("div",{style:{display:"flex",flexWrap:"wrap",gap:"10px",marginTop:"10px"},children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)("strong",{children:"Logical"}),":\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#3-operators",children:"and"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#3-operators",children:"or"})]})})]})]}),(0,r.jsxs)("tr",{children:[(0,r.jsx)("td",{style:{verticalAlign:"top",padding:"10px"},children:(0,r.jsx)("strong",{children:"Conversions"})}),(0,r.jsx)("td",{style:{padding:"10px"},children:(0,r.jsx)("div",{style:{display:"flex",flexWrap:"wrap",gap:"10px"},children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"../modelling-components/expressions#38-operator-precedence",children:"to-date"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#38-operator-precedence",children:"to-date-time"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#5-conversion-operators",children:"to-enum"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#38-operator-precedence",children:"to-int"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#38-operator-precedence",children:"to-number"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#38-operator-precedence",children:"to-string"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#38-operator-precedence",children:"to-time"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#38-operator-precedence",children:"to-zoned-date-time"})]})})})]}),(0,r.jsxs)("tr",{children:[(0,r.jsx)("td",{style:{verticalAlign:"top",padding:"10px"},children:(0,r.jsx)("strong",{children:"Operations"})}),(0,r.jsxs)("td",{style:{padding:"10px"},children:[(0,r.jsx)("div",{style:{display:"flex",flexWrap:"wrap",gap:"10px"},children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"../modelling-components/expressions#46-other-list-operators",children:"count"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#35-default-operators",children:"default"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#43-additional-list-comparison-keywords",children:"disjoint"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#46-other-list-operators",children:"distinct"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#32-comparison-operators",children:"exists"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#41-list-operator-keywords",children:"filter"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#46-other-list-operators",children:"first"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#46-other-list-operators",children:"flatten"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#32-comparison-operators",children:"is absent"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#38-operator-precedence",children:"join"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#46-other-list-operators",children:"last"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#41-list-operator-keywords",children:"min"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#41-list-operator-keywords",children:"max"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#32-comparison-operators",children:"one-of"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#46-other-list-operators",children:"only-element"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#41-list-operator-keywords",children:"reduce"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#22-deep-paths-for-choice-types",children:"required/optional choice"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#38-operator-precedence",children:"reverse"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#46-other-list-operators",children:"sort"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#38-operator-precedence",children:"sum"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#37-with-meta-operator",children:"with-meta"}),"\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#34-arithmetic-operators",children:(0,r.jsx)(n.code,{children:"+"})}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#34-arithmetic-operators",children:(0,r.jsx)(n.code,{children:"-"})}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#34-arithmetic-operators",children:(0,r.jsx)(n.code,{children:"*"})}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#34-arithmetic-operators",children:(0,r.jsx)(n.code,{children:"/"})}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#2-path-expressions",children:(0,r.jsx)(n.code,{children:"->"})}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#22-deep-paths-for-choice-types",children:(0,r.jsx)(n.code,{children:"->>"})}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#2-path-expressions",children:(0,r.jsx)(n.code,{children:"..."})})]})}),(0,r.jsx)("div",{style:{display:"flex",flexWrap:"wrap",gap:"10px",marginTop:"10px"},children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)("strong",{children:"Comparison operations"}),":\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#43-additional-list-comparison-keywords",children:"all"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#43-additional-list-comparison-keywords",children:"any"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#32-comparison-operators",children:(0,r.jsx)(n.code,{children:"="})}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#32-comparison-operators",children:(0,r.jsx)(n.code,{children:"<"})}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#32-comparison-operators",children:(0,r.jsx)(n.code,{children:">"})}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#32-comparison-operators",children:(0,r.jsx)(n.code,{children:"<="})}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#32-comparison-operators",children:(0,r.jsx)(n.code,{children:">="})}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/expressions#32-comparison-operators",children:(0,r.jsx)(n.code,{children:"<>"})})]})})]})]}),(0,r.jsxs)("tr",{children:[(0,r.jsx)("td",{style:{verticalAlign:"top",padding:"10px"},children:(0,r.jsx)("strong",{children:"Annotations"})}),(0,r.jsx)("td",{style:{padding:"10px"},children:(0,r.jsx)("div",{style:{display:"flex",flexWrap:"wrap",gap:"10px"},children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"../modelling-components/metadata#1-annotations",children:"annotation"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/reporting#32-rule-syntax",children:"docReference"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/metadata#23-document-reference-on-a-path",children:"for"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/reporting#21-report-syntax",children:"label"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/reporting#32-rule-syntax",children:"provision"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/reporting#35-repeat-instruction-repeatable-fields",children:"rationale"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/reporting#35-repeat-instruction-repeatable-fields",children:"rationale_author"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/reporting#32-rule-syntax",children:"regulatoryReference"}),",\n",(0,r.jsx)(n.a,{href:"../modelling-components/reporting#21-report-syntax",children:"ruleReference"})]})})})]})]})]})]})}function a(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}}}]);