[{"data":1,"prerenderedAt":931},["ShallowReactive",2],{"content:\u002Funi-env":3,"section:uni-env":7},{"id":4,"title":5,"aside":6,"authors":7,"badges":8,"banner":7,"body":17,"breadcrumb":6,"collapse":922,"description":923,"editLink":6,"extension":924,"fullpage":922,"header":7,"icon":925,"main":7,"meta":926,"navBadges":7,"navTruncate":922,"navigation":7,"path":927,"prevNext":6,"seo":928,"stem":929,"toc":6,"__hash__":930},"content\u002Funi-env\u002Findex.md","uni-env",true,null,[9,13],{"value":10,"to":11,"target":12},"npm","https:\u002F\u002Fwww.npmjs.com\u002Fpackage\u002F@uni-helper\u002Funi-env","_blank",{"value":14,"icon":15,"to":16,"target":12},"source","lucide:code","https:\u002F\u002Fgithub.com\u002Funi-helper\u002Funi-env",{"type":18,"value":19,"toc":909},"minimark",[20,24,28,32,35,93,96,142,182,185,189,299,302,616,619,694,697,800,824,827,830,869,885,888,905],[21,22,23],"p",{},"本库把 uni-app 注入的环境变量导出为带类型的常量，用来判断当前平台与构建信息。",[25,26,27],"h2",{"id":27},"安装",[29,30],"pm-install",{"name":31},"@uni-helper\u002Funi-env",[25,33,34],{"id":34},"使用",[36,37,42],"pre",{"className":38,"code":39,"language":40,"meta":41,"style":41},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","import { appId, isH5, isMpWeixin, platform } from '@uni-helper\u002Funi-env'\n","ts","",[43,44,45],"code",{"__ignoreMap":41},[46,47,50,54,58,62,65,68,70,73,75,78,81,84,87,90],"span",{"class":48,"line":49},"line",1,[46,51,53],{"class":52},"s7zQu","import",[46,55,57],{"class":56},"sMK4o"," {",[46,59,61],{"class":60},"sTEyZ"," appId",[46,63,64],{"class":56},",",[46,66,67],{"class":60}," isH5",[46,69,64],{"class":56},[46,71,72],{"class":60}," isMpWeixin",[46,74,64],{"class":56},[46,76,77],{"class":60}," platform",[46,79,80],{"class":56}," }",[46,82,83],{"class":52}," from",[46,85,86],{"class":56}," '",[46,88,31],{"class":89},"sfazB",[46,91,92],{"class":56},"'\n",[21,94,95],{},"CommonJS 同样可用：",[36,97,101],{"className":98,"code":99,"language":100,"meta":41,"style":41},"language-js shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","const { isMp, platform } = require('@uni-helper\u002Funi-env')\n","js",[43,102,103],{"__ignoreMap":41},[46,104,105,109,111,114,116,119,122,125,129,132,135,137,139],{"class":48,"line":49},[46,106,108],{"class":107},"spNyl","const",[46,110,57],{"class":56},[46,112,113],{"class":60}," isMp",[46,115,64],{"class":56},[46,117,118],{"class":60}," platform ",[46,120,121],{"class":56},"}",[46,123,124],{"class":56}," =",[46,126,128],{"class":127},"s2Zo4"," require",[46,130,131],{"class":60},"(",[46,133,134],{"class":56},"'",[46,136,31],{"class":89},[46,138,134],{"class":56},[46,140,141],{"class":60},")\n",[143,144,146,165],"alert",{"type":145},"warning",[21,147,148,152,153,156,157,160,161,164],{},[149,150,151],"strong",{},"构建期，不是运行时","：本库读取的是 uni-app 在",[149,154,155],{},"构建期","注入的环境值。uni-app 通过 Vite ",[43,158,159],{},"define"," 静态替换 ",[43,162,163],{},"process.env.*","，所以本库拿不到运行时的条件编译效果。",[21,166,167,168,175,176,181],{},"需要条件编译时，请用官方的 ",[169,170,174],"a",{"href":171,"rel":172},"https:\u002F\u002Funiapp.dcloud.net.cn\u002Ftutorial\u002Fplatform.html#preprocessor",[173],"nofollow","跨端兼容 - 条件编译","。需要更强的条件编译时，可以用 ",[169,177,180],{"href":178,"rel":179},"https:\u002F\u002Fgithub.com\u002FKeJunMao\u002Funplugin-preprocessor-directives",[173],"unplugin-preprocessor-directives","。",[25,183,184],{"id":184},"导出",[186,187,188],"h3",{"id":188},"平台",[190,191,192,204],"table",{},[193,194,195],"thead",{},[196,197,198,201],"tr",{},[199,200,184],"th",{},[199,202,203],{},"含义",[205,206,207,224,234,247,274,287],"tbody",{},[196,208,209,215],{},[210,211,212],"td",{},[43,213,214],{},"platform",[210,216,217,220,221],{},[43,218,219],{},"process.env.UNI_PLATFORM","，类型为 ",[43,222,223],{},"BuiltInPlatform",[196,225,226,231],{},[210,227,228],{},[43,229,230],{},"builtInPlatforms",[210,232,233],{},"全部内置平台名的数组",[196,235,236,241],{},[210,237,238],{},[43,239,240],{},"vueAppPlatform",[210,242,243,246],{},[43,244,245],{},"process.env.VUE_APP_PLATFORM","，uni-app 为兼容旧版本注入的别名",[196,248,249,254],{},[210,250,251],{},[43,252,253],{},"appPlatform",[210,255,256,259,260,263,264,263,267,270,271],{},[43,257,258],{},"process.env.UNI_APP_PLATFORM","，值为 ",[43,261,262],{},"android","、",[43,265,266],{},"ios",[43,268,269],{},"harmony"," 或 ",[43,272,273],{},"undefined",[196,275,276,281],{},[210,277,278],{},[43,279,280],{},"subPlatform",[210,282,283,286],{},[43,284,285],{},"process.env.UNI_SUB_PLATFORM","，快应用的子平台",[196,288,289,294],{},[210,290,291],{},[43,292,293],{},"utsPlatform",[210,295,296],{},[43,297,298],{},"process.env.UNI_UTS_PLATFORM",[186,300,301],{"id":301},"平台判断",[190,303,304,313],{},[193,305,306],{},[196,307,308,310],{},[199,309,184],{},[199,311,312],{},"为真时",[205,314,315,333,348,358,368,378,392,406,420,439,457,472,482,492,502,512,522,532,542,552,562,572,582,596,606],{},[196,316,317,322],{},[210,318,319],{},[43,320,321],{},"isH5",[210,323,324,326,327,270,330],{},[43,325,214],{}," 为 ",[43,328,329],{},"h5",[43,331,332],{},"web",[196,334,335,340],{},[210,336,337],{},[43,338,339],{},"isWeb",[210,341,342,326,344,270,346],{},[43,343,214],{},[43,345,332],{},[43,347,329],{},[196,349,350,355],{},[210,351,352],{},[43,353,354],{},"isH5Weixin",[210,356,357],{},"H5 且在微信内置浏览器",[196,359,360,365],{},[210,361,362],{},[43,363,364],{},"isH5Weibo",[210,366,367],{},"H5 且在微博客户端",[196,369,370,375],{},[210,371,372],{},[43,373,374],{},"isH5Alipay",[210,376,377],{},"H5 且在支付宝客户端",[196,379,380,385],{},[210,381,382],{},[43,383,384],{},"isApp",[210,386,387,326,389],{},[43,388,214],{},[43,390,391],{},"app",[196,393,394,399],{},[210,395,396],{},[43,397,398],{},"isAppPlus",[210,400,401,326,403],{},[43,402,214],{},[43,404,405],{},"app-plus",[196,407,408,413],{},[210,409,410],{},[43,411,412],{},"isAppHarmony",[210,414,415,326,417],{},[43,416,214],{},[43,418,419],{},"app-harmony",[196,421,422,427],{},[210,423,424],{},[43,425,426],{},"isAppAndroid",[210,428,429,326,431,433,434,326,436],{},[43,430,253],{},[43,432,262],{},"，或 ",[43,435,293],{},[43,437,438],{},"app-android",[196,440,441,446],{},[210,442,443],{},[43,444,445],{},"isAppIOS",[210,447,448,326,450,433,452,326,454],{},[43,449,253],{},[43,451,266],{},[43,453,293],{},[43,455,456],{},"app-ios",[196,458,459,464],{},[210,460,461],{},[43,462,463],{},"isMp",[210,465,466,468,469],{},[43,467,214],{}," 匹配 ",[43,470,471],{},"^mp-",[196,473,474,479],{},[210,475,476],{},[43,477,478],{},"isMpWeixin",[210,480,481],{},"微信小程序",[196,483,484,489],{},[210,485,486],{},[43,487,488],{},"isMpAlipay",[210,490,491],{},"支付宝小程序",[196,493,494,499],{},[210,495,496],{},[43,497,498],{},"isMpBaidu",[210,500,501],{},"百度小程序",[196,503,504,509],{},[210,505,506],{},[43,507,508],{},"isMpKuaishou",[210,510,511],{},"快手小程序",[196,513,514,519],{},[210,515,516],{},[43,517,518],{},"isMpQQ",[210,520,521],{},"QQ 小程序",[196,523,524,529],{},[210,525,526],{},[43,527,528],{},"isMpToutiao",[210,530,531],{},"抖音小程序",[196,533,534,539],{},[210,535,536],{},[43,537,538],{},"isMpJD",[210,540,541],{},"京东小程序",[196,543,544,549],{},[210,545,546],{},[43,547,548],{},"isMpXHS",[210,550,551],{},"小红书小程序",[196,553,554,559],{},[210,555,556],{},[43,557,558],{},"isMpHarmony",[210,560,561],{},"鸿蒙小程序",[196,563,564,569],{},[210,565,566],{},[43,567,568],{},"isMp360",[210,570,571],{},"360 小程序",[196,573,574,579],{},[210,575,576],{},[43,577,578],{},"isMpLark",[210,580,581],{},"飞书小程序",[196,583,584,589],{},[210,585,586],{},[43,587,588],{},"isQuickapp",[210,590,591,468,593],{},[43,592,214],{},[43,594,595],{},"^quickapp-webview",[196,597,598,603],{},[210,599,600],{},[43,601,602],{},"isQuickappUnion",[210,604,605],{},"快应用联盟",[196,607,608,613],{},[210,609,610],{},[43,611,612],{},"isQuickappHuawei",[210,614,615],{},"华为快应用",[186,617,618],{"id":618},"应用信息",[190,620,621,630],{},[193,622,623],{},[196,624,625,627],{},[199,626,184],{},[199,628,629],{},"来源",[205,631,632,646,658,670,682],{},[196,633,634,639],{},[210,635,636],{},[43,637,638],{},"appId",[210,640,641,642,645],{},"manifest 的 ",[43,643,644],{},"appid","，未配置时为空字符串",[196,647,648,653],{},[210,649,650],{},[43,651,652],{},"appName",[210,654,641,655,645],{},[43,656,657],{},"name",[196,659,660,665],{},[210,661,662],{},[43,663,664],{},"appVersionName",[210,666,641,667,645],{},[43,668,669],{},"versionName",[196,671,672,677],{},[210,673,674],{},[43,675,676],{},"appVersionCode",[210,678,641,679,645],{},[43,680,681],{},"versionCode",[196,683,684,689],{},[210,685,686],{},[43,687,688],{},"debug",[210,690,641,691,693],{},[43,692,688],{},"，布尔值",[186,695,696],{"id":696},"构建与目录",[190,698,699,707],{},[193,700,701],{},[196,702,703,705],{},[199,704,184],{},[199,706,629],{},[205,708,709,721,733,745,757,773,788],{},[196,710,711,716],{},[210,712,713],{},[43,714,715],{},"inputDir",[210,717,718],{},[43,719,720],{},"process.env.UNI_INPUT_DIR",[196,722,723,728],{},[210,724,725],{},[43,726,727],{},"outputDir",[210,729,730],{},[43,731,732],{},"process.env.UNI_OUTPUT_DIR",[196,734,735,740],{},[210,736,737],{},[43,738,739],{},"cliContext",[210,741,742],{},[43,743,744],{},"process.env.UNI_CLI_CONTEXT",[196,746,747,752],{},[210,748,749],{},[43,750,751],{},"compilerVersion",[210,753,754],{},[43,755,756],{},"process.env.UNI_COMPILER_VERSION",[196,758,759,768],{},[210,760,761,764,765],{},[43,762,763],{},"sourcemap"," \u002F ",[43,766,767],{},"hasSourcemap",[210,769,770],{},[43,771,772],{},"process.env.SOURCEMAP",[196,774,775,783],{},[210,776,777,764,780],{},[43,778,779],{},"minimize",[43,781,782],{},"isMinimize",[210,784,785],{},[43,786,787],{},"process.env.UNI_MINIMIZE",[196,789,790,795],{},[210,791,792],{},[43,793,794],{},"runByHBuilderX",[210,796,797,693],{},[43,798,799],{},"process.env.RUN_BY_HBUILDERX",[21,801,802,803,805,806,263,809,263,812,263,815,818,819,181],{},"其余导出与 uni-app 内部的 ",[43,804,163],{}," 一一对应，例如 ",[43,807,808],{},"uvue",[43,810,811],{},"appX",[43,813,814],{},"appPackType",[43,816,817],{},"automatorPort","。完整名单与注释见 ",[169,820,823],{"href":821,"rel":822},"https:\u002F\u002Fgithub.com\u002Funi-helper\u002Funi-env\u002Ftree\u002Fmain\u002Fsrc\u002Findex.ts",[173],"src\u002Findex.ts",[25,825,826],{"id":826},"读取规则",[21,828,829],{},"本库按两条规则选择读取方式：",[831,832,833,841],"ul",{},[834,835,836,837,840],"li",{},"已注册的键用 ",[43,838,839],{},"process.env.X","。uni-app 在构建期把这些键静态替换为字面量，所有目标都能拿到正确值，并能触发 dead-code elimination，裁掉其他平台的死代码。",[834,842,843,844,847,848,263,851,854,855,263,858,861,862,865,866,181],{},"未注册的键用 std-env 的 ",[43,845,846],{},"env.X","。这些键不会被静态替换，运行时经 Proxy 依次回退读取 ",[43,849,850],{},"process?.env",[43,852,853],{},"import.meta.env","、Deno、",[43,856,857],{},"__env__",[43,859,860],{},"globalThis","。这样在没有 ",[43,863,864],{},"process"," 全局的环境里不会抛 ",[43,867,868],{},"process is not defined",[21,870,871,872,875,876,879,880,181],{},"规则来自 uni-app ",[43,873,874],{},"packages\u002Funi-cli-shared\u002Fsrc\u002Fenv\u002Fdefine.ts"," 的 ",[43,877,878],{},"initDefine","。开发约定见 ",[169,881,884],{"href":882,"rel":883},"https:\u002F\u002Fgithub.com\u002Funi-helper\u002Funi-env\u002Fblob\u002Fmain\u002FCONTRIBUTING.md",[173],"CONTRIBUTING.md",[21,886,887],{},"误用后果：",[831,889,890,899],{},[834,891,892,893,895,896,898],{},"未注册键写成 ",[43,894,839],{},"，会在没有 ",[43,897,864],{}," 全局的运行时报错。",[834,900,901,902,904],{},"已注册键写成 ",[43,903,846],{},"，读不到构建期注入的值，也无法被 tree-shaking。",[906,907,908],"style",{},"html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}",{"title":41,"searchDepth":910,"depth":910,"links":911},2,[912,913,914,921],{"id":27,"depth":910,"text":27},{"id":34,"depth":910,"text":34},{"id":184,"depth":910,"text":184,"children":915},[916,918,919,920],{"id":188,"depth":917,"text":188},3,{"id":301,"depth":917,"text":301},{"id":618,"depth":917,"text":618},{"id":696,"depth":917,"text":696},{"id":826,"depth":910,"text":826},false,"在 uni-app 中优雅地判断当前环境。","md","carbon:chart-network",{},"\u002Funi-env",{"title":5,"description":923},"uni-env\u002Findex","G15BGSZufP7sP0-tChiwBU-jfSA0ncNjBmkBBPBdGf8",1795080995905]