node-deadline/lib/jobs/FrameRange.md

Module to interface with Deadline Compute Management System by Thinkbox Software

#Deadline.jobs.FrameRange

A utility class for parsing and managing frame ranges in in Deadline.

###Deadline.jobs.FrameRange( string ) [CONSTRUCTOR]

If passed a string, it is parsed immediately into this object

###Deadline.jobs.FrameRange.parse( string )

Takes a valid Deadline frame range string and expands it to set this object.

###Deadline.jobs.FrameRange.contains( numbers )

Takes a singular number or array of numbers and
returns true if those numbers are included in this frame range.

###Deadline.jobs.FrameRange.add( numbers )

Takes a singular number or array of numbers and
appends them to the current frame range.

###Deadline.jobs.FrameRange.remove( numbers )

Takes a singular number or array of numbers and removes them
from the current frame range if present.

**NOTE** this will force the frame range string to be expanded into a flat list:
( ie `FrameRange("1-100").remove(50)` will change the job string into a list of all number between 1 and 100, skipping 50 )