Usage
Properties
days()
Retrieves the total number of days.
You can optionally specify the minimum number of digits in the returned string (1 | 2 | 3).
You can optionally specify the minimum number of digits in the returned string (1 | 2 | 3).
dayRange()
Retrieves the first and last day numbers as strings, e.g.
You can optionally specify the minimum number of digits in the returned strings (1 | 2 | 3).
[“1”, “52”].You can optionally specify the minimum number of digits in the returned strings (1 | 2 | 3).
dateRange()
Retrieves the first and last date of the project.
Returns a tuple of strings:
Options:
Returns a tuple of strings:
[startDate, endDate]. You can optionally pass formatting options.Options:
dateRange( format: DateFormatOptions )ocf.files()
ocf.size()
Gets the size of all OCF files in a user-friendly format, such as “1.17 GB” or “117 MB”.
You can specify the unit of measurement you prefer by providing an options object. The default unit is
Options:
You can specify the unit of measurement you prefer by providing an options object. The default unit is
“auto”.Options:
ocf.size( type: “auto” | “tb” | “gb” | “mb” | “bytes” )ocf.sizeAsNumber()
Retrieves the OCF size as a numerical value.
This method returns the size in a numerical format, which can be useful for calculations or comparisons. The default unit is
Options:
This method returns the size in a numerical format, which can be useful for calculations or comparisons. The default unit is
“bytes”.Options:
ocf.sizeAsNumber( type: “auto” | “tb” | “gb” | “mb” | “bytes” )ocf.sizeAsTuple()
Obtains the OCF size as a pair containing both the numerical value and its unit.
This method returns an array where the first element is the size number and the second element is the unit. The default unit is
Options:
This method returns an array where the first element is the size number and the second element is the unit. The default unit is
“auto”.Options:
ocf.sizeAsTuple( type: “auto” | “tb” | “gb” | “mb” | “bytes” )ocf.duration()
ocf.durationTC()
ocf.durationObject()
Retrieves the total OCF duration as an object with time components: hours, minutes, and seconds.
proxy.files()
proxy.size()
Gets the size of all proxy files in a user-friendly format, such as “1.17 GB” or “117 MB”.
You can specify the unit of measurement you prefer by providing an options object. The default unit is
Options:
You can specify the unit of measurement you prefer by providing an options object. The default unit is
“auto”.Options:
proxy.size( type: “auto” | “tb” | “gb” | “mb” | “bytes” )proxy.sizeAsNumber()
Retrieves the proxy size as a numerical value.
This method returns the size in a numerical format, which can be useful for calculations or comparisons. The default unit is
Options:
This method returns the size in a numerical format, which can be useful for calculations or comparisons. The default unit is
“bytes”.Options:
proxy.sizeAsNumber( type: “auto” | “tb” | “gb” | “mb” | “bytes” )proxy.sizeAsTuple()
Obtains the proxy size as a pair containing both the numerical value and its unit.
This method returns an array where the first element is the size number and the second element is the unit. The default unit is
Options:
This method returns an array where the first element is the size number and the second element is the unit. The default unit is
“auto”.Options:
proxy.sizeAsTuple( type: “auto” | “tb” | “gb” | “mb” | “bytes” )sound.files()
sound.size()
Gets the size of all sound files in a user-friendly format, such as “1.17 GB” or “117 MB”.
You can specify the unit of measurement you prefer by providing an options object. The default unit is
Options:
You can specify the unit of measurement you prefer by providing an options object. The default unit is
“auto”.Options:
sound.size( type: “auto” | “tb” | “gb” | “mb” | “bytes” )sound.sizeAsNumber()
Retrieves the sound size as a numerical value.
This method returns the size in a numerical format, which can be useful for calculations or comparisons. The default unit is
Options:
This method returns the size in a numerical format, which can be useful for calculations or comparisons. The default unit is
“bytes”.Options:
sound.sizeAsNumber( type: “auto” | “tb” | “gb” | “mb” | “bytes” )sound.sizeAsTuple()
Obtains the sound size as a pair containing both the numerical value and its unit.
This method returns an array where the first element is the size number and the second element is the unit. The default unit is
Options:
This method returns an array where the first element is the size number and the second element is the unit. The default unit is
“auto”.Options:
sound.sizeAsTuple( type: “auto” | “tb” | “gb” | “mb” | “bytes” )