Class: DaysOfWeeksBits

baja. DaysOfWeeksBits


new DaysOfWeeksBits()

Represents a baja:DaysOfWeekBits in BajaScript.

When creating a Simple, always use the make() method instead of
creating a new Object.

Extends

Members


<static> DEFAULT :baja.DaysOfWeekBits

Default DaysOfWeekBits instance.

Type:
  • baja.DaysOfWeekBits

<static> EMPTY :baja.DaysOfWeekBits

DaysOfWeekBits Empty Value.

Type:
  • baja.DaysOfWeekBits

decodeFromString

Decode a DaysOfWeekBits from a String.

Overrides:

encodeToString

Encode the DaysOfWeekBits (itself) to a String.

Overrides:

Methods


<static> make(bits)

Make a DaysOfWeekBits.

Parameters:
Name Type Description
bits Number

the bits value.

Returns:
Type
baja.DaysOfWeekBits

decodeAsync(str [, batch])

The string encoding of certain Simples may include Type information, or
other data that may be require asynchronous operations to decode. BOX is
designed to handle these situations when decoding data from the station,
but when user code needs to decode string-encoded Simples directly, prefer
this method as it gives the individual Simple a chance to import Types,
etc. to ensure that the decoded Simple is fully correct.

The default implementation just returns decodeFromString directly.

Parameters:
Name Type Argument Description
str string
batch baja.comm.Batch <optional>

optional batch to use

Inherited From:
Returns:

may return the Simple instance
directly, or a Promise resolving to same - so wrap in Promise.resolve()
if unsure.

Type
baja.Simple | Promise.<baja.Simple>

equals(obj)

Equality test.

Parameters:
Name Type Description
obj
Inherited From:
Returns:
Type
Boolean

equivalent(obj)

Equivalence test.

equivalent() is used to compare if two Objects have equivalent
state, but might not want to return true for equals since it
it has implied semantics for many operations. The default
implementation returns the result of baja.Object#equals.

Parameters:
Name Type Description
obj
Inherited From:
Returns:
Type
Boolean

getAgents( [is], batch)

Returns a promise that resolves to the agent list for this Object.

Parameters:
Name Type Argument Description
is Array.<String> <optional>

An optional array of filters to add to the
agent query.

batch baja.comm.Batch

An optional object used to batch network
calls together.

Inherited From:
See:
Returns:

A promise that will resolve with the Agent Info.

Type
Promise

getIcon()

Return the Object's Icon.

Inherited From:
Returns:
Type
baja.Icon

getType()

Get the type of this instance.

Inherited From:
Returns:
Type
Type

includes(weekday)

Return whether or not the baja:Weekday enum is active.

Parameters:
Name Type Description
weekday Number | baja.FrozenEnum

the ordinal of the weekday, or a
baja:Weekday enum value.

Returns:
Type
Boolean

make()

Make a DaysOfWeekBits.

Overrides:
See:
  • module:nmodule/bajaScript/rc/baja/obj/DaysOfWeekBits.make

newCopy( [exact])

Every value may be cloned using the newCopy method.

Please note that Simples are immutable so they don't
allocate a new instance.

Parameters:
Name Type Argument Description
exact Boolean <optional>

true if an exact copy of the value should be
made (only valid in the Component architecture).

Inherited From:
See:
Returns:

a copy of the value (or the same instance if the value is a
Simple).


toString()

Return the String representation of the DaysOfWeekBits (itself).

Overrides:
Returns:
Type
String

valueOf()

Return the Number encapsulated in the DaysOfWeekBits (itself).

Overrides:
Returns:
Type
Number