Skip to content

Environment

Environment variable management and .env file loading.

3 modules

ModuleDescription
รับตัวแปรสภาพแวดล้อมรับค่าของตัวแปรสภาพแวดล้อม
โหลดไฟล์ .envโหลดตัวแปรสภาพแวดล้อมจากไฟล์ .env
ตั้งค่าตัวแปรสภาพแวดล้อมตั้งค่าตัวแปรสภาพแวดล้อมในกระบวนการปัจจุบัน

Modules

รับตัวแปรสภาพแวดล้อม

env.get

รับค่าของตัวแปรสภาพแวดล้อม

Parameters:

NameTypeRequiredDefaultDescription
namestringYes-ชื่อตัวแปรสภาพแวดล้อม
defaultstringNo-ค่าเริ่มต้นถ้าตัวแปรไม่ได้ถูกตั้งค่า

Output:

FieldTypeDescription
namestringชื่อตัวแปร
valuestringค่าตัวแปร (หรือค่าเริ่มต้นถ้าไม่ได้ตั้งค่า)
existsbooleanตัวแปรมีอยู่ในสภาพแวดล้อมหรือไม่

Example: Get HOME variable

yaml
name: HOME

Example: Get variable with default

yaml
name: MY_APP_PORT
default: 8080

โหลดไฟล์ .env

env.load_dotenv

โหลดตัวแปรสภาพแวดล้อมจากไฟล์ .env

Parameters:

NameTypeRequiredDefaultDescription
pathstringYes.envเส้นทางไปยังไฟล์ .env
overridebooleanNoFalseเขียนทับตัวแปรสภาพแวดล้อมที่มีอยู่หรือไม่

Output:

FieldTypeDescription
loaded_countnumberจำนวนตัวแปรที่โหลด
variablesarrayรายการชื่อตัวแปรที่ถูกโหลด

Example: Load .env file

yaml
path: .env
override: false

ตั้งค่าตัวแปรสภาพแวดล้อม

env.set

ตั้งค่าตัวแปรสภาพแวดล้อมในกระบวนการปัจจุบัน

Parameters:

NameTypeRequiredDefaultDescription
namestringYes-ชื่อตัวแปรสภาพแวดล้อมที่จะตั้งค่า
valuestringYes-ค่าที่จะกำหนดให้กับตัวแปรสภาพแวดล้อม

Output:

FieldTypeDescription
namestringชื่อตัวแปร
valuestringค่าที่ตั้งค่าใหม่
previous_valuestringค่าก่อนหน้า (null ถ้าไม่ได้ตั้งค่าก่อนหน้า)

Example: Set an environment variable

yaml
name: MY_APP_PORT
value: 3000

Released under the Apache 2.0 License.